CPSFUNC_SET_DATABLOCK function
The CPSFUNC_SET_DATABLOCK function code causes the ComPropSheet function to store a caller-supplied data block. You can use this function code to make the information about a property sheet page available to other pages.
Syntax
LONG_PTR ComPropSheet(
HANDLE hComPropSheet,
UINT Function,
LPARAM lParam1,
LPARAM lParam2
);
Parameters
hComPropSheet
Group parent handle.Function
Caller sets this function code parameter to CPSFUNC_SET_DATABLOCK when it calls ComPropSheet to store a caller-supplied data block.lParam1
Pointer to a CPSUIDATABLOCK structure that describes the data block to be stored.lParam2
Caller-defined DWORD-sized identifier value. It is used to identify the supplied CPSUIDATABLOCK structure in subsequent calls to ComPropSheet using the CPSFUNC_QUERY_DATABLOCK function code.
Return value
If the operation is successful, the ComPropSheet function returns a value representing the number of bytes that were stored; otherwise it returns a value less than or equal to zero.
Remarks
Typically, this function code is used by a _CPSUICALLBACK-typed callback function (when the function's CPSUICBPARAM structure contains a Reason value of CPSUICB_REASON_KILLACTIVE) to save values associated with a page before it becomes inactive.
Requirements
Target platform |
Desktop |
Header |
Compstui.h (include Compstui.h) |
See also