Dbxakey()

From Recital Documentation Wiki
Revision as of 16:31, 1 May 2009 by Yvonnemilne (Talk | contribs)

Jump to: navigation, search

PURPOSE

add keys to all tags in the tagged index file


SYNOPSIS

#include "dbl.h"
 
	int	dbxakey(dbx, recno);
 
	<input parameters>
	char	*dbx;		/* Tagged index file descriptor */
	long	recno;		/* Record number */
 
	<output parameters>
	none


RETURN VALUE

The dbxakey() 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 dbxakey() function adds a key to each index tag in the tagged index file, .DBX for the record number specified.


EXAMPLE

The following example opens the table and tag index, locks the table and tag index, adds in records, flushes the buffers, then unlocks and closes the files.


#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);
 
	static char *text_table[] =  {
		"Santa Margarita   80.027.5   700000095/01/01Spanish  ",
		"Santa Rosa        81.824.8  3000000032/01/01Spanish  ",
		"Unknown galleon   83.123.0         015/01/01Spanish  ",
		"Jessie            97.127.4    10000075/01/01U.S.     ",
		"Lea               96.227.8   100000080/01/01U.S.     ",
		"S.J. Lee          96.926.9    20000075/01/01U.S.     ",
		"Genovase          78.418.4   185000030/01/01Spanish  ",
		"Unknown Vessel    77.517.9         075/01/01U.S.     "
	};
 
	main()
	{
	int	rc; 			/* Return Code for error handling */
	char	*dbf; 		/* File descriptor for table */
	char	*dbx; 		/* File descriptor for tagged index */
	int	i;	 		/* Loop control variable */
	long	recno; 		/* Table record variable */
 
	rc = dbdcache(100);
	errorproc("dbdcache()","table cache specified.", rc);
	rc = dbicache(100);
	errorproc("dbicache()", "index cache specified.",rc);
	rc = dbfilemode(1,0);
	rc = dbopen("shipwreck.dbf", &dbf);
	errorproc("dbopen()","table opened in shared mode.", rc);
 
	rc = dbxopen(dbf, "shipwreck.dbx", &dbx);
	errorproc("dbxopen()","tagged index opened.", rc);
 
	for( i = 1; i <= 7; i++)  {
		rc = dbappend(dbf, text_table[i], &recno);
		errorproc("dbappend()", "record appended.", rc);
		rc = dbxlocki(dbx);
		errorproc("dbxlocki()",  "tagged index file locked.", rc);
		rc = dbxakey(dbx, recno);
		errorproc("dbxakey()",  "key added.", rc);
		rc = dbxunlocki(dbx);
		errorproc("dbxunlocki()",  "tagged index file unlocked.", rc);
	}
 
	rc = dbflush(dbf);
	errorproc("dbflush()", "table cache flushed.", rc);
	rc = dbxflsh(dbx);
	errorproc("dbxflsh()", "Tagged index cache flushed.", 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

dbappend(), dbxclose(), dbxflsh(), dbxlocki(), dbxopen(), dbxunlocki()