GetCPSUIUserData function

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 following Remarks section.

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. (Dialog box procedures are described in the Microsoft Windows SDK documentation.)

Requirements

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