ADRPARMADRPARM*
*Contents  *Index  *Topic Contents
*Previous Topic: ADRLIST
*Next Topic: ENTRYID

ADRPARM

typedef struct _ADRPARM 
{ 
    ULONG            cbABContEntryID; 
    LPENTRYID        lpABContEntryID; 
    ULONG            ulFlags; 
    LPVOID           lpReserved; 
    ULONG            ulHelpContext; 
    LPTSTR           lpszHelpFileName; 
    LPFNABSDI        lpfnABSDI; 
    LPFNDISMISS      lpfnDismiss; 
    LPVOID           lpvDismissContext; 
    LPTSTR           lpszCaption; 
    LPTSTR           lpszNewEntryTitle; 
    LPTSTR           lpszDestWellsTitle; 
    ULONG            cDestFields; 
    ULONG            nDestFieldFocus; 
    LPTSTR FAR      *lppszDestTitles; 
    ULONG FAR       *lpulDestComps; 
    LPSRestriction   lpContRestriction; 
    LPSRestriction   lpHierRestriction; 
} ADRPARM, FAR *LPADRPARM;

Describes the display and behavior of the common address dialog box.

cbABContEntryID
List of entries that can be added to the recipient wells.
lpABContEntryID
Address of an ENTRYID of a container that will supply the list of one-offs that can be added to the recipient wells of the address book common dialog box. The address book container that lpABContEntryID points to determines what is listed in the edit box within the dialog box that holds possible recipient names. Usually, lpABContEntryID is NULL, indicating the use of a custom recipient provider.
ulFlags
Bitmask of flags associated with various address dialog box options. The following flags can be set:
AB_RESOLVE Causes all names to be resolved after the address book dialog box is closed. The Resolve Name dialog box is displayed if there are ambiguous entries in the recipient list.
AB_SELECTONLY Disables the creation of custom recipient addresses and direct type-in entries for a recipient list. This flag is used only if the dialog box is modal.
ADDRESS_ONE Indicates that the user of the dialog box can select exactly one message recipient, instead of a number of recipients from a recipient list. This flag is valid only when cDestFields is zero. This flag is used only if the dialog box is modal.
DIALOG_MODAL Causes a modal dialog box to be displayed. The client must set either this flag or DIALOG_SDI, but not both.
DIALOG_OPTIONS Not supported by Internet Explorer Address Book.
DIALOG_SDI Causes a modeless dialog box to be displayed. This call returns immediately and thus does not modify the ADRLIST structure passed in. The caller must set either this flag or DIALOG_MODAL, but not both.
lpReserved
Reserved; must be zero.
ulHelpContext
Not supported by Internet Explorer Address Book. Should be zero.
lpszHelpFileName
Not supported by Internet Explorer Address Book. Should be NULL.
lpfnABSDI
Address of an Internet Explorer Address Book function based on the ACCELERATEABSDI (see MAPI documentation) prototype, or NULL. This member applies to the modeless version of the dialog box only, as indicated by the DIALOG_SDI flag being set.

Clients building an ADRPARM structure to pass to IAddrBook::Address must always set the lpfnABSDI member to NULL. If the DIALOG_SDI flag is set, Internet Explorer Address Book then sets it to a valid function before returning. Clients call this function from within their message loop to ensure that accelerators in the address book dialog box work. When the dialog box is dismissed and Internet Explorer Address Book calls the function pointed to by the lpfnDismiss member, clients should unhook the ACCELERATEABSDI function from their message loop.

lpfnDismiss
Address of a function based on the DISMISSMODELESS (see MAPI documentation) prototype, or NULL. This member applies only to the modeless version of the dialog box, as indicated by the DIALOG_SDI flag being set. Internet Explorer Address Book calls the DISMISSMODELESS function when the user dismisses the modeless address dialog box, informing a client calling IAddrBook::Address that the dialog box is no longer active.
lpvDismissContext
Address of the context information to be passed to the DISMISSMODELESS function pointed to by the lpfnDismiss member. This member applies to the modeless version of the dialog box only, as indicated by the DIALOG_SDI flag being set.
lpszCaption
Address of the text to be used as a caption for the address book dialog box.
lpszNewEntryTitle
Address of the text to be used as a new-entry prompt for an edit box in an address book dialog box.
lpszDestWellsTitle
Address of text to be used as a title for the set of recipient-name edit boxes that appears in the dialog box. This member is used only if the address book dialog box is modal.
cDestFields
Number of recipient-name edit boxes (that is, destination fields) in the address book dialog box. A number from 0 through 3 is typical. If the cDestFields member is zero and the ADDRESS_ONE flag is not set in ulFlags, the address book is open for browsing only.
nDestFieldFocus
Field in the address book dialog box that should have the initial focus when the dialog box appears. This value must be between 0 and the value of cDestFields minus 1.
lppszDestTitles
Address of an array of text titles to be displayed in the recipient-name edit boxes of the address book dialog box. The size of the array is the value of cDestFields. If the lppszDestTitles member is NULL, the IAddrBook::Address method chooses default titles.
lpulDestComps
Address of an array of recipient types, such as MAPI_TO, MAPI_CC, and MAPI_BCC, associated with each recipient-name edit box. The size of the array is the value of cDestFields. If the lpulDestComps member is NULL, the IAddrBook::Address method chooses default recipient types.
lpContRestriction
Not supported by Internet Explorer Address Book. Should be NULL.
lpHierRestriction
Not supported by Internet Explorer Address Book. Should be NULL.

Back to top

Up Top of Page
© 1997 Microsoft Corporation. All rights reserved. Terms of Use.