dbm-firstkey

Arguments: ndbm &key return external-format

dbm-firstkey starts a database traversal process and returns the first key found by that process. ndbm should be a database returned by dbm-open. This generic function is used in combination with dbm-nextkey to traverse a database.

Keys are not stored in any interesting order. If return is supplied (the value can be :string or :usb8), it determines the return data type, otherwise the default as determined by dbm-open is used. If the return type is :string, then external-format is used to convert the data to a string. If external-format is not supplied, then again the default as determined by dbm-open is used.

Note: If you call dbm-store or dbm-delete while traversing a database using dbm-firstkey/dbm-nextkey, you should restart the traversal by calling dbm-firstkey again.

See ndbm.htm for information on the NDBM facility.

Copyright (c) 1998-2019, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 8.2 page.
Created 2012.5.30.