CPSFUNC_SET_RESULT function
The CPSFUNC_SET_RESULT function code causes the ComPropSheet function to pass a specified result value to all PFNPROPSHEETUI-typed functions associated with a specified page and its parents.
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_RESULT when it calls ComPropSheet to pass a specified result value to all PFNPROPSHEETUI-typed functions associated with a specified page and its parents.lParam1
Caller-supplied CPSUI handle to the page for which a result value is being passed. If lParam1 is NULL, the CPSUI uses the value specified by hComPropSheet.lParam2
Caller-supplied 32-bit DWORD result value. For more information, see the following Remarks section.
Return value
If the operation is successful, the ComPropSheet function returns the number of PFNPROPSHEETUI-typed functions that were called. If the handle specified for lParam1 is invalid, the function returns -1.
Remarks
For more information about how to set result values, see the description of the SETRESULT_INFO structure.
The following caution applies to Unidrv- or Pscript5-based IHV UI plug-in with custom UI property sheets, and for which user settings made in the property sheets should be persistent. When the plug-in calls the ComPropSheet function with the Function parameter set to CPSFUNC_SET_RESULT, the plug-in must set the lParam2 parameter to CPSUI_OK.
Requirements
Target platform |
Desktop |
Header |
Compstui.h (include Compstui.h) |