AddressBook - cMapiHandler
Used to browse / select an entry from the Addressbook
Type: Function
Return Data Type: Integer
Parameters
| Parameter | Type | Description |
|---|---|---|
| sDialogCaption | String | Text to display in the caption bar of the opened addressbook panel |
Syntax
Function AddressBook String sDialogCaption Returns Integer
Call Example
Get AddressBook sDialogCaption to IntegerVariable
Description
This function is used to browse / select an entry from the Addressbook. It calls the MAPIAddress function.
This function returns one of the following error codes if not successful:
| Error code | Meaning |
|---|---|
| 1 | The user canceled one of the dialog boxes. The name was not resolved. |
| 2 | One or more unspecified errors occurred. No message was sent. |
| 3 | There was no default logon, and the user failed to log on successfully when the logon dialog box was displayed. No message was sent. |
| 5 | There was insufficient memory to proceed. No message was sent. |
| 19 | An invalid session handle was used for the lhSession parameter. No list of recipient entries was returned. |
| 24 | The value of the nEditFields parameter was outside the range of 0 through 4. No list of recipient entries was returned. |
| 25 | One or more of the recipients in the address list was not valid. No list of recipient entries was returned. |
| 26 | The operation was not supported by the underlying messaging system. |
Example
Get AddressBook Of oMapiSession "Select one or more receivers" To iRetval
Return Value
Returns zero if successful, otherwise returns a non-zero error code.