JsGetTypedArrayStorage Function

Obtains the underlying memory storage used by a typed array.

Syntax

STDAPI_(JsErrorCode) JsGetTypedArrayStorage(  
   _In_ JsValueRef typedArray,  
   _Outptr_result_bytebuffer_(*bufferLength) BYTE **buffer,  
   _Out_ unsigned int *bufferLength,  
   _Out_opt_ JsTypedArrayType *arrayType,  
   _Out_opt_ int *elementSize  
);  

Parameters

typedArray
The typed array instance.

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

bufferLength
The number of bytes in the buffer.

arrayType
The type of the array.

elementSize
The size of an element of the array.

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)