Difference between revisions of "Dbxdroptag()"

From Recital Documentation Wiki
Jump to: navigation, search
 
 
Line 12: Line 12:
  
 
<input parameters>
 
<input parameters>
char *dbx; /* Tagged index file descriptor */
+
char *dbx; /* Tagged index file descriptor */
char *tagname; /* Address of a buffer containing the name of the tag to be dropped */
+
char *tagname; /* Address of a buffer containing the name of the tag to be dropped */
  
 
<output parameters>
 
<output parameters>
Line 39: Line 39:
 
<code lang="c">
 
<code lang="c">
 
#include <stdio.h>
 
#include <stdio.h>
#include "dbl.h" /* Recital/Library include file */
+
#include "dbl.h" /* Recital/Library include file */
#include "dblproto.h" /* Recital/Library prototype file */
+
#include "dblproto.h" /* Recital/Library prototype file */
  
 
static dBFIELD fields[6] = {
 
static dBFIELD fields[6] = {
 
"VESSEL", 'C', 18, 0, 0,
 
"VESSEL", 'C', 18, 0, 0,
"LAT", 'N', 4, 1, 0,
+
"LAT", 'N', 4, 1, 0,
"LONG", 'N', 4, 1, 0,
+
"LONG", 'N', 4, 1, 0,
 
"AMOUNT", 'N', 10, 0, 0,
 
"AMOUNT", 'N', 10, 0, 0,
"DATE", 'D', 8, 0, 0,
+
"DATE", 'D', 8, 0, 0,
"FLAG", 'C', 9, 0, 0
+
"FLAG", 'C', 9, 0, 0
 
};
 
};
  
Line 58: Line 58:
 
main()
 
main()
 
{
 
{
int rc; /* Return Code for error handling */
+
int rc; /* Return Code for error handling */
char *dbf; /* File descriptor for table */
+
char *dbf; /* File descriptor for table */
char *dbx; /* File descriptor for tagged index */
+
char *dbx; /* File descriptor for tagged index */
  
rc = dbdcache(100);
+
rc = dbdcache(100);
errorproc("dbdcache()","table cache specified.", rc);
+
errorproc("dbdcache()","table cache specified.", rc);
rc = dbicache(100);
+
rc = dbicache(100);
errorproc("dbicache()", "index cache specified.", rc);
+
errorproc("dbicache()", "index cache specified.", rc);
rc = dbfilemode(0,0);
+
rc = dbfilemode(0,0);
rc = dbopen("shipwreck.dbf", &dbf);
+
rc = dbopen("shipwreck.dbf", &dbf);
errorproc("dbopen()","table opened in exclusive mode.", rc);
+
errorproc("dbopen()","table opened in exclusive mode.", rc);
  
rc = dbxcreate( dbf,
+
rc = dbxcreate( dbf,
 
fields[5].fieldnm, /* "FLAG", */
 
fields[5].fieldnm, /* "FLAG", */
 
&dbx,
 
&dbx,
Line 77: Line 77:
 
0,
 
0,
 
0);
 
0);
errorproc("dbxcreate()","tag created", rc);
+
errorproc("dbxcreate()","tag created", rc);
  
rc = dbxdroptag(dbx, fields[5].fieldnm);
+
rc = dbxdroptag(dbx, fields[5].fieldnm);
errorproc("dbxdroptag()","tagged index 'FLAG' dropped.", rc);
+
errorproc("dbxdroptag()","tagged index 'FLAG' dropped.", rc);
  
rc = dbxclose(dbx);
+
rc = dbxclose(dbx);
errorproc("dbxclose()", "tagged index closed.", rc);
+
errorproc("dbxclose()", "tagged index closed.", rc);
rc = dbclose(dbf);
+
rc = dbclose(dbf);
errorproc("dbclose()", "table closed.", rc);
+
errorproc("dbclose()", "table closed.", rc);
  
exit(0);
+
exit(0);
 
}
 
}
  
Line 96: Line 96:
 
{
 
{
 
if ( rc != SUCCESS ) {
 
if ( rc != SUCCESS ) {
printf("n  Error performing function %s -> %dn", func, rc);
+
printf("\n  Error performing function %s -> %d\n", func, rc);
exit(1);
+
exit(1);
 
}
 
}
printf("Function: t%s, t%s - Okn", func, str);
+
printf("Function: \t%s, \t%s - Ok\n", func, str);
 
return;
 
return;
 
}
 
}

Latest revision as of 15:03, 5 May 2009

PURPOSE

drop the specified tag from the tagged index file


SYNOPSIS

#include "dbl.h"
 
	int	dbxdroptag(dbx, tagname)
 
	<input parameters>
	char	*dbx;		/* Tagged index file descriptor */
	char	*tagname;	/* Address of a buffer containing the name of the tag to be dropped */
 
	<output parameters>
	none


RETURN VALUE

The dbxdroptag() function returns 0 for success, or < 0 if an error occurs. See the section on return code values for a detailed list of return codes.


DESCRIPTION

The dbxdroptag() function is used to drop tag indexes from a specified tagged index file, .DBX. If the dropped tag is the last tag in the file then the .DBX file is removed, as there must be at least one tag in the file.


EXAMPLE

The following example creates a tag on the FLAG field for the shipwreck.dbf table, then drops the tag.


#include <stdio.h>
#include "dbl.h"			/* Recital/Library include file */
#include "dblproto.h"		/* Recital/Library prototype file */
 
	static	dBFIELD fields[6] = {
		"VESSEL",	'C',	18,	0,	0,
		"LAT",		'N',	4,	1,	0,
		"LONG",		'N',	4,	1,	0,
		"AMOUNT",	'N',	10,	0,	0,
		"DATE",		'D',	8,	0,	0,
		"FLAG",		'C',	9,	0,	0
	};
 
	static void errorproc(
		char	*func,
		char	*str,
		int	rc);
 
	main()
	{
		int	rc; 		/* Return Code for error handling */
		char	*dbf; 	/* File descriptor for table */
		char	*dbx; 	/* File descriptor for tagged index */
 
		rc = dbdcache(100);
		errorproc("dbdcache()","table cache specified.", rc);
		rc = dbicache(100);
		errorproc("dbicache()", "index cache specified.", rc);
		rc = dbfilemode(0,0);
		rc = dbopen("shipwreck.dbf", &dbf);
		errorproc("dbopen()","table opened in exclusive mode.", rc);
 
		rc = dbxcreate( dbf,
			fields[5].fieldnm,		/* "FLAG",	*/
			&dbx,
			fields[5].fieldnm,		/* "FLAG",	*/
			NULL,
			0,
			0);
		errorproc("dbxcreate()","tag created", rc);
 
		rc = dbxdroptag(dbx, fields[5].fieldnm);
		errorproc("dbxdroptag()","tagged index 'FLAG' dropped.", rc);
 
		rc = dbxclose(dbx);
		errorproc("dbxclose()", "tagged index closed.", rc);
		rc = dbclose(dbf);
		errorproc("dbclose()", "table closed.", rc);
 
		exit(0);
}
 
	static void errorproc(func, str, rc)
	char	*func;
	char	*str;
	int	rc;
{
	if ( rc != SUCCESS ) {
		printf("\n  Error performing function %s -> %d\n", func, rc);
		exit(1);
	}
	printf("Function: \t%s, \t%s - Ok\n", func, str);
	return;
}


SEE ALSO

dbxclose(), dbxcreate(), dbxtag()