Function EN Version 12.11

@GetDominoUsers

Misc NotesAdmin NotesSystem

Syntax

@GetDominoUsers(SERVER;FIELDLIST);
@GetDominoUsers(SERVER;FIELDLIST;LOOKUPFLAGS);
@GetDominoUsers(SERVER;FIELDLIST;LOOKUPFLAGS;RETDATATYPE);
@GetDominoUsers(SERVER;FIELDLIST;LOOKUPFLAGS;RETDATATYPE;SEPERATORSTRING);
@GetDominoUsers(SERVER;FIELDLIST;LOOKUPFLAGS;RETDATATYPE;SEPERATORSTRING;VIEWNAME);

Description

This @Function retrieves the specified fields TEXT/TEXTLIST FIELDLIST for all users registered in the Domino Directory of the specified Domino server TEXT SERVER.
The returned field values are provided as a TEXTLIST or HUGETEXTLIST. The values of the requested fields from each user document are combined into a single list element and separated by the specified separator string.

TEXT SERVER:
Specifies the server to be queried. To query the local server, specify an empty string ("").

TEXT/TEXTLIST FIELDLIST:
This parameter specifies the fields to be retrieved from the Person documents in the address books of the queried server.
The fields must have the data type TEXT or TEXTLIST in the address book document. Fields with any other data type are interpreted as an empty string (""). For TEXTLIST fields, only the first element is returned.
Examples:
FullName, ShortName, FirstName, MiddleInitial, LastName, AltFullName, AltFullNameLanguage, InternetAddress, MailServer, MailFile, MailDomain, MailSystem, MailAddress, MessageStorage, …

FN LOOKUPFLAGS:
DEC   BIT   Bedeutung
0001   01   Returns all entries in the view.
0002   02   Limits the search to the first Names database containing the specified view. Other Names databases are not searched, even if they contain a matching entry.
0032   06   The search does not stop after the first match, but continues looking for additional matching entries.
0256   09   Ensures that the namespaces (views) used for the lookup are brought up to date before the search is performed.
To specify multiple flags, add the values of the corresponding flags or construct the value using @BitVektor.
The default is 33 (bits 01, 06).

TEXT
RETDATATYPE:
Specifies the desired return data type.
TL   TEXTLIST (default)
HTL   HUGETEXTLIST

TEXT SEPERATORSTRING:
Specifies the separator string used to separate the requested fields.
The default separator is a comma ",".
Example:
If FullName and MailServer are requested, an element may look as follows when using the default comma separator:
CN=Max Mustermann/O=ACME/C=DE,CN=MAIL-SERVER-01/O=ACME/C=DE

TEXT VIEWNAME:
Specifies the name of the view to be used as the source in the address books.
The default is "$People", but another view, such as "$Users", can also be used.

If an error occurs, the @Function returns @ERROR. Otherwise, it returns a list containing the requested fields in the specified return data type.

Beispiel: @GetDominoUsers(SERVER;FIELDLIST;LOOKUPFLAGS;RETDATATYPE;SEPERATORSTRING;VIEWNAME);

SERVER:="";
FIELDLIST:="FullName":"MailServer";
LOOKUPFLAGS:=1;
RETDATATYPE:="TL";
SEPERATORSTRING:="##";
VIEWNAME:="$People";
RET:=@GetDominoUsers(SERVER;FIELDLIST;LOOKUPFLAGS;RETDATATYPE;SEPERATORSTRING;VIEWNAME);
@LogReport(@Implode(RET;@Newline);3);

All documents in the "$People" view on the local server are queried, and the FullName and MailServer fields are retrieved.
The return data type is TEXTLIST, and "##" is used as the separator between the fields of each document.
The result of the query is written to the APILOG.

Note : This text was machine-translated and may contain inaccuracies.