IMAPISupport::Details

Published: July 16, 2012

Displays a dialog box that shows details about a particular address book entry.

HRESULT Details(
  ULONG_PTR FAR * lpulUIParam,
  LPFNDISMISS lpfnDismiss,
  LPVOID lpvDismissContext,
  ULONG cbEntryID,
  LPENTRYID lpEntryID,
  LPFNBUTTON lpfButtonCallback,
  LPVOID lpvButtonContext,
  LPSTR lpszButtonText,
  ULONG ulFlags
);

lpulUIParam

[out] A pointer to the handle to the parent window of the returned dialog box.

lpfnDismiss

[in] A pointer to a function based on the DISMISSMODELESS prototype, or NULL. This member applies only to the modeless version of the dialog box, as indicated by the DIALOG_SDI flag being set. MAPI calls the DISMISSMODELESS function when the user dismisses the modeless address dialog box, informing a client that is calling IMAPISupport::Details that the dialog box is no longer active.

lpvDismissContext

[in] A pointer to context information to pass to the DISMISSMODELESS function pointed to by the lpfnDismiss parameter. This parameter applies only to the modeless version of the dialog box, by including the DIALOG_SDI flag in the ulFlags parameter.

cbEntryID

[in] The byte count in the entry identifier pointed to by the lpEntryID parameter.

lpEntryID

[in] A pointer to the entry identifier for which details are displayed.

lpfButtonCallback

[in] A pointer to a function based on the LPFNBUTTON function prototype. An LPFNBUTTON function adds a button to the details dialog box.

lpvButtonContext

[in] A pointer to data used as a parameter for the function specified by the lpfButtonCallback parameter.

lpszButtonText

[in] A pointer to a string that contains text to be applied to the added button if that button is extensible. The lpszButtonText parameter should be NULL if an extensible button is not needed.

ulFlags

[in] A bitmask of flags that controls the type of the text for the lpszButtonText parameter. The following flag can be set:

DIALOG_MODAL

Display the modal version of the common address dialog box. This flag is mutually exclusive with DIALOG_SDI.

DIALOG_SDI

Display the modeless version of the common address dialog box. This flag is mutually exclusive with DIALOG_MODAL.

MAPI_UNICODE

The passed-in strings are in Unicode format. If the MAPI_UNICODE flag is not set, the strings are in ANSI format.

S_OK

The details dialog box was successfully displayed for the address book entry.

The IMAPISupport::Details method is implemented for address book provider support objects. Address book providers call Details to display a dialog box that gives details on a particular entry in the address book. The lpfButtonCallback, lpvButtonContext, and lpszButtonText parameters can be used to add a client-defined button to the dialog box. When the button is clicked, MAPI calls the callback function pointed to by lpfButtonCallback, passing both the entry identifier of the button and the data in lpvButtonContext. If an extensible button is not needed, lpszButtonText should be NULL.

Community Additions

ADD
Show:
© 2014 Microsoft