Platform SDK: MAPI

DTBLPAGE

The DTBLPAGE structure describes a tabbed page to be used in a dialog box that is built from a display table.

Quick Info

Header file: MAPIDEFS.H
Related macro: SizedDtblPage

typedef struct _DTBLPAGE 
{ 
     ULONG ulbLpszLabel; 
     ULONG ulFlags; 
     ULONG ulbLpszComponent; 
     ULONG ulContext; 
} DTBLPAGE, FAR *LPDTBLPAGE; 
 

Members

ulbLpszLabel
Position in memory of the character string label for the page tab.
ulFlags
Bitmask of flags used to designate the format of the label pointed to by the ulbLpszLabelName member. The following flag can be set:
MAPI_UNICODE
The label is in Unicode format. If the MAPI_UNICODE flag is not set, the label is in ANSI format.
ulbLpszComponent
Position in memory of a character string identifying the [Help File Mappings] section in the MAPISVC.INF configuration file or 0. The file name appearing in the MAPISVC.INF section can be used by a user to access extended Help for the tabbed page by clicking the Help button on the dialog box. For more information about the entries in MAPISVC.INF, see File Format of MAPISVC.INF.
ulContext
A unique identifier for the tabbed page within the string defined by the ulbLpszComponent member. The ulbLpszComponent member and the ulContext member must both be nonzero in order for the Help button to work. If this identifier is zero and the component string is NULL, there is no Help associated with the page.

Remarks

A DTBLPAGE structure describes a tabbed page — a control that is used to separate several related dialog boxes. Typically, these dialog boxes are property sheets for showing configuration, message, or recipient options. By clicking the tab, the user can switch from one sheet to another.

The following dialog box includes four tabbed page controls: one control for each type of property relating to a particular address type.

The component string and context identifier provide information about whether or not extended Help is available for the tabbed page and if it is available, how to access it. The component string maps to the Help file; the context identifier maps to the initial Help topic. If the context identifier is zero and the component string is NULL, extended Help is not available.

For an overview of display tables, see Display Tables. For information about implementing a display table, see Implementing a Display Table.

See Also

Display Table Structures, DTCTL