Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

WsGetHeapProperty function

Retrieves a particular property of a specified Heap.

Syntax


HRESULT WINAPI  WsGetHeapProperty(
  _In_     WS_HEAP*            heap,
  _In_     WS_HEAP_PROPERTY_ID id,
           void*               value,
  _In_     ULONG               valueSize,
  _In_opt_ WS_ERROR*           error
);

Parameters

heap [in]

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

id [in]

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.

valueSize [in]

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

error [in, optional]

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

Minimum supported client

Windows 7 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 R2 [desktop apps | Windows Store apps]

Header

WebServices.h

Library

WebServices.lib

DLL

WebServices.dll

 

 

Community Additions

Show:
© 2017 Microsoft