WsGetHeapProperty function (webservices.h)

Retrieves a particular property of a specified Heap.

Syntax

HRESULT WsGetHeapProperty(
  [in]           WS_HEAP             *heap,
  [in]           WS_HEAP_PROPERTY_ID id,
                 void                *value,
  [in]           ULONG               valueSize,
  [in, optional] WS_ERROR            *error
);

Parameters

[in] heap

A pointer to the Heap object to that contains the desired property data.

[in] id

This is a WS_HEAP_PROPERTY_ID enumerator that identifies the desired property.

value

A reference to the retrieved property value. The pointer must have an alignment compatible with the type of the property.

[in] valueSize

The buffer size allocated by the caller for the retrieved property value.

[in, optional] error

A pointer to a WS_ERROR object where additional information about the error should be stored if the function fails.

Return value

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements