Share via


JsGetArrayBufferStorage Function

Obtains the underlying memory storage used by an ArrayBuffer.

Syntax

JsErrorCode STDAPI_ JsGetArrayBufferStorage(  
   _In_ JsValueRef arrayBuffer,  
   _Outptr_result_bytebuffer_(*bufferLength) BYTE **buffer,  
   _Out_ unsigned int *bufferLength  
);  

Parameters

arrayBuffer
The ArrayBuffer instance.

buffer
The ArrayBuffer's buffer. The lifetime of the buffer returned is the same as the lifetime of the ArrayBuffer. The buffer pointer does not count as a reference to the ArrayBuffer for the purpose of garbage collection.

bufferLength
The number of bytes in the buffer.

Return Value

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

Remarks

Requires an active script context.

This API is supported only in Microsoft Edge mode.

Requirements

Header: jsrt.h

See Also

Reference (JavaScript Runtime)