CPSFUNC_LOAD_CPSUI_ICON function

The CPSFUNC_LOAD_CPSUI_ICON function code causes the ComPropSheet function to load a CPSUI-supplied icon 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_ICON when it calls ComPropSheet to load a CPSUI-supplied icon resource.

  • lParam1
    Resource identifier of the CPSUI-supplied icon to be loaded. This must be an IDI_CPSUI-prefixed identifier as defined in Compstui.h.

  • lParam2
    Specifies two WORD-sized values representing the icon's size, in pixels. The LOWORD value is the width, and the HIWORD value is the height. If these values are zero, the system metrics SM_CXICON and SM_CYICON are used. (See GetSystemMetrics in the Microsoft Windows SDK documentation.)

Return value

If the operation succeeds, the ComPropSheet function returns an icon handle; otherwise it returns NULL.

Remarks

CPSUI calls LoadImage (described in the Windows SDK documentation) to load the specified icon resource.

Requirements

Target platform

Desktop

Header

Compstui.h (include Compstui.h)

 

 

Send comments about this topic to Microsoft