Description

Displays a standard dialog box containing the details of a given address list entry which may or may not be modified. Below is sample output for the contact detail window produced by the example for this function:

Syntax

status = MAPIDetails([session] [, parent] [, flags], name)

Parameters

The MAPIDetails function has the following parameters.

ParameterDescription
sessionContains a MAPI session handle returned by MAPILogon. If not specified a system default session will be initiated, if possible, or a sign-in dialog box will be displayed. In any case, MAPI will return to its previous state upon completion of the function.
parentContains the name of an OpenInsight parent window. If not specified the dialog box will be application modal.
flagsContains information about session initiation and detail modification. It could be MAPI_LOGON_UI$, MAPI_NEW_SESSION$, MAPI_DIALOG$, MAPI_AB_NOMODIFY$, or a combination of these flags.
  • MAPI_LOGON_UI$ indicates that MAPI should display a sign-in dialog box, if necessary. If the session parameter is specified this flag is ignored.
  • MAPI_NEW_SESSION$ indicates that MAPI should establish a new session and not attempt to share another MAPI client's session or the default session. If the session parameter is specified this flag is ignored.
  • MAPI_DIALOG$ indicates that MAPI should display a dialog box to resolve ambiguous names.
  • MAPI_AB_NOMODIFY$ indicates that the details may not be modified even if they belong to the personal address book.

The insert record MAPI_EQUATES contains these flags. You may combine flags by adding them together with an addition sign (+).

nameContains the name of the address book entry whose details are to be displayed.

After the details dialog completes successfully the entry in the address book may have been updated if the MAPI_AB_NOMODIFY$ flag has not been specified.

Returns

1 for successful execution or 0 for failure.

If function execution fails, you can retrieve a text error message by calling the Get_Status function. For example, to display an error message on the screen, include the following error handling routine in your code:

Get_Status(ErrMsg)
Msg(@window, ErrMsg)

See also

Get_Status(), MAPIAddress()

Remarks

Subroutine DemoMAPIDetails(var)
* Display address book details dialog box for Trudy
$INSERT MAPI_EQUATES
Declare Function MAPIDetails
Declare Subroutine Msg, Get_Status
flags = MAPI_LOGON_UI$
name  = "Trudy Jones"
if MAPIDetails(0, 0, flags, name) else  
       Get_Status(display)
    Msg(@window, display)
end
return
  • No labels