CPSFUNC_QUERY_DATABLOCK function

The CPSFUNC_QUERY_DATABLOCK function code causes the ComPropSheet function to retrieve a caller-supplied data block that was previously stored using the CPSFUNC_SET_DATABLOCK function code.

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_QUERY_DATABLOCK when it calls ComPropSheet to retrieve a caller-supplied data block.

• lParam1
  Pointer to a CPSUIDATABLOCK structure that identifies the size and location of a buffer to receive the requested data block.

• lParam2
  DWORD-sized identifier value, used to identify the requested CPSUIDATABLOCK structure. This value must have been specified in a previous call to ComPropSheet using the CPSFUNC_SET_DATABLOCK function code.

Return value

If the operation succeeds, the ComPropSheet function returns a value that represents the size of the retrieved data block. If lParam1 is NULL, or if the value of any member of the supplied CPSUIDATABLOCK structure is zero, ComPropSheet returns the size required to store the data block. If an error occurs, the function 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_SETACTIVE) to retrieve values associated with another page before the current page becomes inactive.

Requirements

See also

_CPSUICALLBACK

CPSFUNC_SET_DATABLOCK

CPSUICBPARAM

CPSUIDATABLOCK

Send comments about this topic to Microsoft