@GetAddressBooks (Formula Language)

Returns a list of the address books associated with a client (if the current database is local) or server.

Note: This @function is new with Release 6.

Syntax

@GetAddressBooks( [ options ] )

Parameters

[ options ]

Keyword. You must select one of the following keywords as an argument for this @function:

[TITLES]

Returns the file names of the address books associated with the current database.

[FIRSTONLY]

Displays only the first database in the returned text list of address book names.

Return value

address books

Text or text list. When the current database is hosted by a server, returns the address books that exist on that server. When the current database is hosted locally, returns the address books listed in the NAMES= line of the notes.ini file for that client.

Examples

  1. This code populates the chooseAddress listbox field options with "names.nsf" and "AcmeNorthServer!!names.nsf" when added to the Use formula for choices textbox on the Control tab of the field properties box if the database containing the chooseAddress field is running on the Acme server:
    @GetAddressBooks([TITLES])
  2. This code populates the chooseAddress listbox field options with "names.nsf" when added to the Use formula for choices textbox on the Control tab of the field properties box if the database containing the chooseAddress field is running on the Acme server:
    @GetAddressBooks([FIRSTONLY])