GetAddressBookData()

Returns Address Book information (backward compatibility only). Use Address Book commands to return Address Book information.

Token ID

AFTKN_GET_ABDATA or 606

Syntax

GetAddressBookData([VARIABLE MacroVariable]; 
                    ENUM Section; 
                    ENUM Query; 
                    [WORD FieldNum]; 
                    [ANSISTRING UserIDOrGroupName]; 
                    [ENUM Disambiguate])

Parameters

MacroVariable As VARIABLE

(Optional) Output variable assigned the return value of the Query parameter.

Section As ENUM

Address book section to query, as follows:

159

ExternalAddess!

For other mail systems.

3

PersonalGroups!

2

PublicGroups!

1

Resources!

0

Users!
Query As ENUM

Query type, as follows:

Value

Query Type

Description

2

Entry

Returns field contents.

1

Field

Returns the field name.

0

FieldCount

Returns the number of fields in a specified section.
FieldNum As WORD

(Optional) Field number to query.

UserIDOrGroupName As ANSISTRING

(Optional) User ID or group name to query.

Disambiguate As ENUM

(Optional) Choose the correct user when two or more users have the same ID.

Value

Choice

Description

0

No

Redirects macro execution to an ONERROR label. The macro fails if an ONERROR label is not specified.

1

Yes

Displays the list of users and prompts you to choose one.

Return Values

Any.

See Also