IAddrBook::Details
This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
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,
LPTSTR lpszButtonText,
ULONG ulFlags
);
Parameters
lpulUIParam
[out] A handle to the parent window for the 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 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 the entry 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 that was 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 you do not need an extensible button.ulFlags
[in] A bitmask of flags that controls the type of the text for the lpszButtonText parameter. The following flags can be set:AB_TELL_DETAILS_CHANGE
Indicates that Details returns TRUE if changes are actually made to the address; otherwise, Details returns FALSE.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.
Return Value
- S_OK
The details dialog box was successfully displayed for the address book entry.
Remarks
Client applications call the Details method to display a dialog box that provides details about a particular entry in the address book. You can use the lpfButtonCallback, lpvButtonContext, and lpszButtonText parameters 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 you do not need an extensible button, lpszButtonText should be NULL.
Details supports Unicode character strings; Unicode strings are converted to the multibyte character string (MBCS) format before they are displayed in the details dialog box.
MFCMAPI Reference
For MFCMAPI sample code, see the following table.
File |
Function |
Comment |
|---|---|---|
BaseDialog.cpp |
CBaseDialog::OnOpenEntryID |
MFCMAPI uses the Details method to display a dialog box that shows the details for an address book entry. |