EXTCHKBOX structure (compstui.h)

Article
11/24/2022

The EXTCHKBOX structure is used by CPSUI applications (including printer interface DLLs) for specifying an extended check box, which can be added to a property sheet page option.

Syntax

typedef struct _EXTCHKBOX {
  WORD      cbSize;
  WORD      Flags;
  LPTSTR    pTitle;
  LPTSTR    pSeparator;
  LPTSTR    pCheckedName;
  ULONG_PTR IconID;
  WORD      wReserved[4];
  ULONG_PTR dwReserved[2];
} EXTCHKBOX, *PEXTCHKBOX;

Members

cbSize

Size, in bytes, of the EXTCHKBOX structure.

Flags

Bit flags, which can be one of the following:

ECBF_CHECKNAME_AT_FRONT

If set, CPSUI displays strings in the order "pCheckedName pSeparator SelectName", where SelectName is the string associated with the option's selected value.

If not set, CPSUI displays strings in the order "SelectName pSeparator pCheckedName".

ECBF_CHECKNAME_ONLY_ENABLED

If set, CPSUI displays the pCheckedName string only if the option is checked and enabled (that is, OPTIF_ECB_CHECKED is set and OPTIF_DISABLED is clear in the OPTITEM structure).

If not set, CPSUI always displays the pCheckedName string if the option is checked (that is, OPTIF_ECB_CHECKED is set in the OPTITEM structure), even if the option is disabled.

ECBF_ICONID_AS_HICON

If set, the IconID member contains an icon handle.

If not set, the IconID member contains an icon resource identifier.

ECBF_OVERLAY_ECBICON_IF_CHECKED

If set, and if the check box is checked (that is, OPTIF_ECB_CHECKED is set in the OPTITEM structure), CPSUI overlays the icon identified by the IconID member onto the icon associated with the option item.

ECBF_OVERLAY_NO_ICON

If set, CPSUI overlays its IDI_CPSUI_NO icon onto the icon identified by the IconID member.

ECBF_OVERLAY_STOP_ICON

If set, CPSUI overlays the IDI_CPSUI_STOP icon onto the icon identified by the IconID member.

ECBF_OVERLAY_WARNING_ICON

If set, CPSUI overlays its IDI_CPSUI_WARNING icon onto the icon identified by the IconID member.

pTitle

String identifier, representing the check box title. This can be a 32-bit pointer to a NULL-terminated string, or it can be a 16-bit string resource identifier with HIWORD set to zero.

pSeparator

String identifier, representing a separator character to be displayed between the checked name string and the selected option string This can be a 32-bit pointer to a NULL-terminated string, or it can be a 16-bit string resource identifier with HIWORD set to zero.

pCheckedName

String identifier, representing the text to be displayed when the check box is checked. This can be a 32-bit pointer to a NULL-terminated string, or it can be a 16-bit string resource identifier with HIWORD set to zero.

IconID

One of the following icon identifiers:

An icon resource identifier. This can be application-defined, or it can be one of the CPSUI-supplied, IDI_CPSUI-prefixed icon resource identifiers.
An icon handle. If a handle is specified, ECBF_ICONID_AS_HICON must be set in the Flags member.

If this value is zero, an icon is not displayed.

wReserved[4]

Reserved, must be initialized to zero.

dwReserved[2]