OPTPARAM structure (compstui.h)

Article
02/22/2024

An array of OPTPARAM structures is used by CPSUI applications (including printer interface DLLs) for describing all the parameter values associated with a property sheet option. The array's address is included in an OPTTYPE structure.

Syntax

typedef struct _OPTPARAM {
  WORD      cbSize;
  BYTE      Flags;
  BYTE      Style;
  LPTSTR    pData;
  ULONG_PTR IconID;
  LPARAM    lParam;
  ULONG_PTR dwReserved[2];
} OPTPARAM, *POPTPARAM;

Members

cbSize

Size, in bytes, of the OPTPARAM structure.

Flags

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

OPTPF_DISABLED

If set, the parameter is not user-selectable. Can be used with the following option types:

OPTPF_HIDE

If set, the parameter not displayed in the treeview. Can be used with the following option types:

TVOT_3STATES

TVOT_COMBOBOX

TVOT_LISTBOX

OPTPF_ICONID_AS_HICON

If set, the IconID member contains an icon handle.

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

OPTPF_OVERLAY_NO_ICON

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

OPTPF_OVERLAY_STOP_ICON

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

OPTPF_OVERLAY_WARNING_ICON

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

OPTPF_USE_HDLGTEMPLATE

If set, lParam contains a template handle.

If not set, lParam contains a template resource identifier.

(Used only if Style is PUSHBUTTON_TYPE_DLGPROC.)

Style

Push button style, used only for the TVOT_PUSHBUTTON option type.

pData

Pointer to the parameter's value. Use of this member is dependent on the CPSUI option type.

IconID

Usually identifies the icon to be associated with the option parameter, but is sometimes used for other purposes. Use of this member is dependent on the CPSUI option type.

lParam

Use of this member is dependent on the CPSUI option type.

dwReserved[2]

Reserved, must be initialized to zero.

Remarks

If the OPTPF_HIDE flag is set in all the OPTPARAM structures associated with an option, CPSUI hides the entire option.

Requirements

Requirement	Value
Header	compstui.h (include Compstui.h)

Share via