The Open Group Base Specifications Issue 7, 2018 edition
IEEE Std 1003.1-2017 (Revision of IEEE Std 1003.1-2008)
Copyright © 2001-2018 IEEE and The Open Group

NAME

ndbm.h - definitions for ndbm database operations

SYNOPSIS

[XSI] [Option Start] #include <ndbm.h> [Option End]

DESCRIPTION

The <ndbm.h> header shall define the datum type as a structure, which shall include at least the following members:

void   *dptr  A pointer to the application's data. 
size_t  dsize The size of the object pointed to by dptr. 

The <ndbm.h> header shall define the size_t type as described in <stddef.h>.

The <ndbm.h> header shall define the DBM type.

The <ndbm.h> header shall define the following symbolic constants as possible values for the store_mode argument to dbm_store():

DBM_INSERT
Insertion of new entries only.
DBM_REPLACE
Allow replacing existing entries.

The following shall be declared as functions and may also be defined as macros. Function prototypes shall be provided.

int     dbm_clearerr(DBM *);
void    dbm_close(DBM *);
int     dbm_delete(DBM *, datum);
int     dbm_error(DBM *);
datum   dbm_fetch(DBM *, datum);
datum   dbm_firstkey(DBM *);
datum   dbm_nextkey(DBM *);
DBM    *dbm_open(const char *, int, mode_t);
int     dbm_store(DBM *, datum, datum, int);

The <ndbm.h> header shall define the mode_t type through typedef, as described in <sys/types.h>.


The following sections are informative.

APPLICATION USAGE

None.

RATIONALE

None.

FUTURE DIRECTIONS

None.

SEE ALSO

<stddef.h>, <sys/types.h>

XSH dbm_clearerr

CHANGE HISTORY

First released in Issue 4, Version 2.

Issue 5

References to the definitions of size_t and mode_t are added to the DESCRIPTION.

Issue 7

This reference page is clarified with respect to macros and symbolic constants.

End of informative text.

 

return to top of page

UNIX ® is a registered Trademark of The Open Group.
POSIX ® is a registered Trademark of The IEEE.
Copyright © 2001-2018 IEEE and The Open Group, All Rights Reserved
[ Main Index | XBD | XSH | XCU | XRAT ]