CPSFUNC_LOAD_CPSUI_STRING function
The CPSFUNC_LOAD_CPSUI_STRING function code causes the ComPropSheet function to load a CPSUI-supplied string resource.
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_LOAD_CPSUI_STRING when it calls ComPropSheet to load a CPSUI-supplied string resource.lParam1
An LPSTR-typed pointer to a caller-allocated buffer, into which the CPSUI-supplied string specified by HIWORD(lParam2) will be placed.lParam2
Contains the following two caller-supplied values:LOWORD(lParam2). Size, in bytes, of the buffer pointed to by lParam1.
HIWORD(lParam2). Resource identifier of the CPSUI-supplied string to be loaded. This must be an IDS_CPSUI-prefixed identifier as defined in Compstui.h.
Return value
If the operation succeeds, the ComPropSheet function returns the length of the string. If an invalid resource identifier is specified, the function returns zero. If lParam1 is NULL or LOWORD(lParam2) is zero, the function returns -1.
Remarks
The ComPropSheet function calls LoadString (described in the Microsoft Windows SDK documentation) to load the specified string.
Requirements
Target platform |
Desktop |
Header |
Compstui.h (include Compstui.h) |