Edit

Share via

GetCPSUIUserData function (compstui.h)

  • Article

CPSUI's GetCPSUIUserData function retrieves data that was previously stored using the SetCPSUIUserData function.

Syntax

ULONG_PTR GetCPSUIUserData(
  HWND hDlg
);

Parameters

hDlg

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

Return value

If the operation succeeds, the function returns the value that was previously supplied to SetCPSUIUserData; otherwise the function returns zero.

Remarks

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

The handle specified for hDlg must be the handle received as input to the dialog box procedure. For more information, see Dialog box programming considerations.

Requirements

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