AddressListCreateFromGroup()

Constructs an address list from a group or distribution list. Creates an address list from a public or personal group. Default: personal group. To specify a public group, use the full address string. Not recordable.

Token ID

AFTKN_AL_CREATE_FROM_GROUP or 740

Syntax

DWORD AddressListCreateFromGroup(ANSISTRING GroupName; 
                                  [ANSISTRING UserID]) 

Parameters

GroupName As ANSISTRING

Public or personal group name, such as the name of a distribution list. If domain and host are absent, the GroupName is assumed to be personal.

UserID As ANSISTRING

(Optional) User ID of the mailbox that contains the Address Book information. Use this parameter to search a proxy mailbox.

Return Values

DWORD. Handle to the list of addresses in the group. Check the return value for a value of zero, which means an error occurred.

Remarks

IMPORTANT:Delete the address list handle when it is no longer needed, or system resources will be lost. See AddressListDelete().

For personal groups, ensure that the personal address book in which the group resides is listed as a selected book in the Name Completion Search Order dialog in the GroupWise client. Otherwise, the token fails.