JsIsEnumeratingHeap Function

Returns a value that indicates whether the heap of the current context is being enumerated.

Syntax

STDAPI_(JsErrorCode) JsIsEnumeratingHeap(
   _Out_ bool *isEnumeratingHeap
);

Parameters

  • isEnumeratingHeap
    Whether the heap is being enumerated.

Return Value

The code JsNoError if the operation succeeded, a failure code otherwise.

Remarks

Requires an active script context.

This API is supported in desktop apps, but is not supported in Store apps.

Requirements

Header: jsrt.h

See Also

Reference (JavaScript Runtime)