Edit

Share via

SetCPSUIUserData function (compstui.h)

  • Article

CPSUI's SetCPSUIUserData function allows CPSUI applications (including printer interface DLLs) to associate non-displayed data with a property sheet dialog box.

Syntax

BOOL SetCPSUIUserData(
  HWND      hDlg,
  ULONG_PTR CPSUIUserData
);

Parameters

hDlg

Caller-supplied handle to a property sheet dialog box. For more information, see the Remarks section below.

CPSUIUserData

Caller-supplied value to be stored.

Return value

The function returns TRUE if it is successful in associating the non-displayed data with the property sheet dialog box, and FALSE otherwise.

Remarks

The SetCPSUIUserData function should be called only from within a dialog box procedure that has been associated with a dialog box by using a DLGPAGE or an EXTPUSH structure.

A value that is stored by calling SetCPSUIUserData can be later retrieved by calling GetCPSUIUserData.

The handle specified for hDlg must be the handle received as input to the dialog box procedure.

Requirements

Requirement Value
Target Platform Desktop
Header compstui.h (include Compstui.h)
Library Compstui.lib
DLL Compstui.dll