Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 | --- dbm.3 2005-07-28 16:23:28.000000000 -0700 +++ dbm.3.edit 2006-07-12 11:16:35.000000000 -0700 @@ -33,28 +33,54 @@ .Nm dbm_store .Nd database access functions .Sh SYNOPSIS -.In fcntl.h .In ndbm.h -.Ft DBM * -.Fn dbm_open "const char *base" "int flags" "int mode" +.Ft int +.Fo dbm_clearerr +.Fa "DBM *db" +.Fc .Ft void -.Fn dbm_close "DBM *db" +.Fo dbm_close +.Fa "DBM *db" +.Fc .Ft int -.Fn dbm_store "DBM *db" "datum key" "datum data" "int flags" -.Ft datum -.Fn dbm_fetch "DBM *db" "datum key" +.Fo dbm_delete +.Fa "DBM *db" +.Fa "datum key" +.Fc +.Ft int +.Fo dbm_dirfno +.Fa "DBM *db" +.Fc .Ft int -.Fn dbm_delete "DBM *db" "datum key" +.Fo dbm_error +.Fa "DBM *db" +.Fc .Ft datum -.Fn dbm_firstkey "DBM *db" +.Fo dbm_fetch +.Fa "DBM *db" +.Fa "datum key" +.Fc .Ft datum -.Fn dbm_nextkey "DBM *db" -.Ft int -.Fn dbm_error "DBM *db" -.Ft int -.Fn dbm_clearerr "DBM *db" +.Fo dbm_firstkey +.Fa "DBM *db" +.Fc +.Ft datum +.Fo dbm_nextkey +.Fa "DBM *db" +.Fc +.Ft DBM * +.Fo dbm_open +.Fa "const char *file" +.Fa "int open_flags" +.Fa "mode_t file_mode" +.Fc .Ft int -.Fn dbm_dirfno "DBM *db" +.Fo dbm_store +.Fa "DBM *db" +.Fa "datum key" +.Fa "datum content" +.Fa "int store_mode" +.Fc .Sh DESCRIPTION Database access functions. These functions are implemented using @@ -74,38 +100,38 @@ .Ed .Pp The -.Fn dbm_open base flags mode +.Fn dbm_open file open_flags file_mode function -opens or creates a database. +opens or creates a database file. The -.Fa base +.Fa file argument is the basename of the file containing the database; the actual database has a .Pa .db suffix. I.e., if -.Fa base +.Fa file is .Qq Li /home/me/mystuff then the actual database is in the file .Pa /home/me/mystuff.db . The -.Fa flags +.Fa open_flags and -.Fa mode +.Fa file_mode arguments are passed to .Xr open 2 . .Pq Dv O_RDWR | O_CREAT is a typical value for -.Fa flags ; +.Fa open_flags ; .Li 0660 is a typical value for -.Fa mode . +.Fa file_mode . .Dv O_WRONLY is treated as O_RDWR in -.Fa flags . +.Fa open_flags . The pointer returned by .Fn dbm_open identifies the database and is the @@ -130,18 +156,18 @@ normally returns zero. .Pp The -.Fn dbm_store db key data flags +.Fn dbm_store db key content store_mode function inserts or replaces an entry in the database. The -.Fa flags +.Fa store_mode argument is either .Dv DBM_INSERT or .Dv DBM_REPLACE . If -.Fa flags +.Fa store_mode is .Dv DBM_INSERT and the database already contains an entry for @@ -153,7 +179,7 @@ function normally returns zero but returns 1 if the entry could not be inserted (because -.Fa flags +.Fa store_mode is .Dv DBM_INSERT , and an entry with @@ -168,7 +194,7 @@ returns .Dv NULL or the -.Fa data +.Fa content corresponding to .Fa key . .Pp @@ -223,10 +249,30 @@ .Fn dbm_dirfno db function returns the file descriptor to the database. +.Sh LEGACY SYNOPSIS +.Fd #include <fcntl.h> +.Fd #include <ndbm.h> +.Pp +The include file +.In ndbm.h +is necessary for all functions. +.Pp +.Ft DBM * +.br +.Fo dbm_open +.Fa "const char *file" +.Fa "int open_flags" +.Fa "int file_mode" +.Fc ; +.Pp +.Fa file_mode +has type +.Vt int . .Sh SEE ALSO .Xr open 2 , .Xr dbopen 3 , -.Xr hash 3 +.Xr hash 3 , +.Xr compat 5 .Sh STANDARDS These functions (except .Fn dbm_dirfno ) |