Platform SDK: MAPI

DTPAGE

The DTPAGE structure describes the dialog box that is built from a display table by the BuildDisplayTable function.

Quick Info

Header file: MAPIUTIL.H

typedef struct DTPAGE
{ 
     ULONG        cctl; 
     LPTSTR       lpszResourceName; 
     union
     {
          LPTSTR              lpszComponent; 
          ULONG               ulItemID; 
      }
     LPDTCTL      lpctl; 
}    DTPAGE, FAR *LPDTPAGE; 
 

Members

cctl
Count of controls pointed to by the lpctl member.
lpszResourceName
Pointer to the name or integer identifier for the dialog box resource.
lpszComponent
Pointer to the string that appears in the [Help File Mappings] section in MAPISVC.INF. Because lpszComponent is in a union with the ulItemID member, only one of these members has valid data.
ulItemID
Integer resource identifier with a value less than or equal to 65535 from which the Help file name can be read. Because ulItemID is in a union with the lpszComponent member, only one of these members has valid data.
lpctl
Pointer to an array of DTCTL structures, one for each control on the page.

Remarks

To identify the Help file for the tabbed page, set either the lpszComponent member to a hard-coded string or the ulItemID member to an integer resource identifier.

Each entry in the [Help File Mappings] section in MAPISVC.INF consists of a component string, no longer than 30 characters, on the left side and a Help file path on the right. Both ulItemID and lpszResourceName are found in the hInstance parameter of BuildDisplayTable. For more information, see MAPISVC.INF [Help File Mappings] Section.

Although BuildDisplayTable uses this structure to build the display table from control resources, the DTPAGE structure never appears in the display table itself.

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, BuildDisplayTable, DTBLPAGE, DTCTL