WsResetHeap function (webservices.h)

Article
02/22/2024

Releases all Heap allocations. Allocations made on the Heap using WsAlloc are no longer valid. Allocation for the Heap object itself is not released.

Syntax

HRESULT WsResetHeap(
  [in]           WS_HEAP  *heap,
  [in, optional] WS_ERROR *error
);

Parameters

[in] heap

A pointer to a Heap instance to reset. If the heap is not required for the given type this parameter can be NULL.

The heap object.

[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.

Remarks

The heap object can retain allocated memory even though it has been reset. The amount of memory retained can be specified using the WS_HEAP_PROPERTY_TRIM_SIZE property when creating the heap.

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2008 R2 [desktop apps \| UWP apps]
Target Platform	Windows
Header	webservices.h
Library	WebServices.lib
DLL	WebServices.dll

Share via