Difference between revisions of "Dbakey()"

From Recital Documentation Wiki
Jump to: navigation, search
Line 8: Line 8:
 
#include<dbl.h>
 
#include<dbl.h>
 
 
    int     dbakey(ndx, key, recno)
+
int dbakey(ndx, key, recno)
  
    <input parameters>
+
<input parameters>
    char   *ndx;  /* .NDX file descriptor */
+
char *ndx;  /* .NDX file descriptor */
    char   key;    /* Address of a buffer containing the key */
+
char key;    /* Address of a buffer containing the key */
    long   recno;  /* Record number */
+
long recno;  /* Record number */
  
    <output parameters>
+
<output parameters>
    none
+
none
 
</source>
 
</source>
  
Line 37: Line 37:
 
#include "dbl.h"
 
#include "dbl.h"
  
char   *ndx;   /* .NDX file descriptor */
+
char *ndx; /* .NDX file descriptor */
int     rc;     /* Return code */
+
int rc; /* Return code */
  
 
rc=dbakey(ndx,"John Smith 5". (long)5);
 
rc=dbakey(ndx,"John Smith 5". (long)5);
Line 44: Line 44:
 
else  
 
else  
 
{
 
{
    printf("error number %d \n", rc);
+
printf("error number %d \n", rc);
    exit (1);
+
exit (1);
 
}
 
}
  

Revision as of 10:52, 15 April 2009

PURPOSE

add key


SYNOPSIS

#include<dbl.h>
 
	int	dbakey(ndx, key, recno)
 
	<input parameters>
	char	*ndx;   /* .NDX file descriptor */
	char	key;    /* Address of a buffer containing the key */
	long	recno;  /* Record number */
 
	<output parameters>
	none


RETURN VALUE

The dbakey() 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

This function adds a key with its associated record number to the specified .NDX file which contains keys in a B-tree structure.


EXAMPLE

The following example adds a character key "John Smith 5" and its associated record number 5 to the index file whose descriptor is in "char *ndx".

#include "dbl.h"
 
char	*ndx;	/* .NDX file descriptor */
int	rc;	/* Return code */
 
rc=dbakey(ndx,"John Smith 5". (long)5);
if (rc = = SUCCESS) printf("key added \n");
else 
{
	printf("error number %d \n", rc);
	exit (1);
}


SEE ALSO

dbatokey(), dbicreat(), dbiflsh(), dbrmvkey(), dbtkey(), dbupdr()