usr/src/man/man3head/ndbm.h.3head

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright 1991, 1992, 1994, The X/Open Company Ltd.
  44 .\" Portions Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved
  45 .\"
  46 .TH NDBM.H 3HEAD "Aug 30, 2002"
  47 .SH NAME
  48 ndbm.h, ndbm \- definitions for ndbm database operations
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 \fB#include <ndbm.h>\fR
  53 .fi
  54
  55 .SH DESCRIPTION
  56 .sp
  57 .LP
  58 The \fB<ndbm.h>\fR header defines the  \fBdatum\fR type as a  structure that
  59 includes at least the following members:
  60 .sp
  61 .in +2
  62 .nf
  63 void   *dptr     /* pointer to the application's data */
  64 size_t dsize     /* size of the object pointed to by dptr */
  65 .fi
  66 .in -2
  67
  68 .sp
  69 .LP
  70 The \fBsize_t\fR type is defined through \fBtypedef\fR as described in
  71 <\fBstddef.h\fR>.
  72 .sp
  73 .LP
  74 The  <\fBndbm.h\fR> header defines the  \fBDBM\fR type through \fBtypedef\fR.
  75 .sp
  76 .LP
  77 The following constants are defined as possible values for the \fIstore_mode\fR
  78 argument to  \fBdbm_store()\fR:
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBDBM_INSERT\fR \fR
  83 .ad
  84 .RS 16n
  85 Insertion of new entries only.
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fBDBM_REPLACE\fR \fR
  92 .ad
  93 .RS 16n
  94 Allow replacing existing entries.
  95 .RE
  96
  97 .SH ATTRIBUTES
  98 .sp
  99 .LP
 100 See \fBattributes\fR(5) for descriptions of the following attributes:
 101 .sp
 102
 103 .sp
 104 .TS
 105 box;
 106 c | c
 107 l | l .
 108 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 109 _
 110 Interface Stability     Standard
 111 .TE
 112
 113 .SH SEE ALSO
 114 .sp
 115 .LP
 116 \fBndbm\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)