OPTTYPE structure (compstui.h)

Article
02/22/2024

The OPTTYPE structure is used by CPSUI applications (including printer interface DLLs) for describing the type and other characteristics of a property sheet option, if the option is specified by an OPTITEM structure.

Syntax

typedef struct _OPTTYPE {
  WORD      cbSize;
  BYTE      Type;
  BYTE      Flags;
  WORD      Count;
  WORD      BegCtrlID;
  POPTPARAM pOptParam;
  WORD      Style;
  WORD      wReserved[3];
  ULONG_PTR dwReserved[3];
} OPTTYPE, *POPTTYPE;

Members

cbSize

Size, in bytes, of the OPTTYPE structure.

Type

Specifies the CPSUI option type.

Flags

Optional bit flags that modify the option's characteristics. The following flags can be set in any combination.

OPTTF_NOSPACE_BEFORE_POSTFIX

CPSUI should not add a space character between the string specified by the OPTITEM structure's pName string and the OPTPARAM structure's pData string, when displaying the option.

Valid only if the option type is or TVOT_SCROLLBAR or TVOT_TRACKBAR.

OPTTF_TYPE_DISABLED

All the OPTPARAM structures to which pOptParam points are disabled, so that none of the parameter values are user-selectable.

Count

Specifies the number of OPTPARAM structures to which pOptParam points. This member's value is dependent on the CPSUI option type.

BegCtrlID

If pDlgPage in COMPROPSHEETUI identifies a CPSUI-supplied page, or if DlgTemplateID in DLGPAGE identifies a CPSUI-supplied template, BegCtrlID is not used.

Otherwise, BegCtrlID must contain the first of a sequentially numbered set of Windows control identifiers. Control identifier usage is dependent on the CPSUI option type.

pOptParam

Pointer to an array of OPTPARAM structures describing the parameter values that a user can select for the option.

Style

Specifies flags that can be used to modify the option's display characteristics. The flags that can be specified are dependent on the CPSUI option type.

wReserved[3]

Reserved, must be initialized to zero.

dwReserved[3]