CPSFUNC_GET_HPSUIPAGES function

The CPSFUNC_GET_HPSUIPAGES function code causes the ComPropSheet function to return an array of CPSUI handles that point to property sheet pages. These handles identify the child pages associated with the specified group parent handle.

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_GET_HPSUIPAGES when it calls ComPropSheet to retireve an array of CPSUI handles.

  • lParam1
    Pointer to an array of HANDLE structures.

  • lParam2
    Size of the HANDLE array pointed to by lParam1.

Return value

The ComPropSheet function returns the number of handles that CPSUI places into the HANDLE array.

Remarks

To use this function code, follow these steps:

1. Call ComPropSheet, specifying the CPSFUNC_GET_PAGECOUNT function code, to obtain the number of child pages associated with the specified group parent.

2. Allocate enough local memory to contain a HANDLE structure for each page.

3. Call ComPropSheet again, specifying the CPSFUNC_GET_HPSUIPAGES function code and the address of the locally allocated memory, to obtain an array of HANDLE structures.

Requirements

Target platform

Desktop

Header

Compstui.h (include Compstui.h)

See also

CPSFUNC_GET_PAGECOUNT

 

 

Send comments about this topic to Microsoft