EXTCHKBOX

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

The EXTCHKBOX structure describes the extended check box available to an option item. Each option item can optionally have one extended push button or one extended check box callback. A selection item with an extended check box can be checked or unchecked, based on user input.

Members

cbSize

Size of this structure in bytes.

Flags

Bitmask that describes the extended check box. This field can be a bitwise OR of the following values.

Flag	Description
ECBF_CHECKNAME_ AT_FRONT	The CPSUI displays the strings associated with this extended check box as follows in the treeview: “pCheckedName pSeparator SelectName”, where SelectName is the string associated with the selected option item. By default, the CPSUI displays the check box treeview strings as “SelectName pSeparator pCheckedName”.
ECBF_CHECKNAME_ ONLY_ENABLED	If this check box is visible and enabled, the CPSUI displays only the string to which pCheckedName points in the treeview.
ECBF_ICONID_AS_HICON	The CPSUI interprets IconID as a handle to an icon rather than as a resource ID.
ECBF_OVERLAY_ WARNING_ICON	The CPSUI overlays its IDI_CPSUI_WARNING icon on the icon associated with this check box.
ECBF_OVERLAY_ ECBICON_IF_CHECKED	The CPSUI overlays the icon associated with this check box on the icon associated with the option item if the check box is checked.
ECBF_OVERLAY_ STOP_ICON	The CPSUI overlays the IDI_CPSUI_STOP icon on the icon associated with this check box.
ECBF_OVERLAY_ NO_ICON	The CPSUI overlays its IDI_CPSUI_NO icon on the icon associated with this check box.

pTitle

Pointer to a null-terminated string to be used as the extended check box title, or a resource ID.

pSeparator

Pointer to the separator that the CPSUI uses in an option item’s entry on a treeview page or the static title control on the non-treeview page.

pCheckedName

Pointer to a null-terminated string that the CPSUI displays in the treeview if the check box is checked, or a resource ID.

IconID

Identifies the icon to be associated with this check box. This field can be a standard IDI_CPSUI_Xxx icon ID, a caller’s icon resource ID, or, if the ECBF_ICONID_AS_HICON bit is set in Flags, a handle to a caller-defined icon. If IconID is zero, the selectable entry does not have an icon associated with it.

wReserved[4]

Reserved; these fields must be set to zero.

dwReserved[2]

Reserved; these fields must be set to zero.

Comments

The EXTCHKBOX structure describes the extended check box available to an option item.

The pTitle parameter is either a pointer to a null-terminated string or an integer value that specifies a resource identifier. If pTitle specifies a resource identifier, its high-order word must be zero and its low-order word must contain the identifier. This is also true for the pCheckedName parameter.

See Also

OPTITEM