PackUint16VectorArray Data Member Function

Deep copies the data from the source array object to a destination <Image> object. The source array remains unchanged and the <Image> object and array objects retain unique ownership of their underlying memory. This function can be regarded as a bounds-checked version of memcpy(). Non-zero indicates success, zero indicates failure.

Prototype

int32 PackUint16VectorArray( Uint16VectorArray p_oSource, Image p_oDest, Uint16Vector p_oPadding )

Parameters

Parameter Type Parameter Name Documentation
<Uint16VectorArray>p_oSourceThe source array object.
<Image>p_oDestThe destination <Image> object.
<Uint16Vector>p_oPaddingA pointer to an object representing the padding value of any bytes in the <Image> object not provided with data from the source array. This value is irrelevant if the size in bytes of the source array is equal to or greater than the size in bytes of the destination <Image> object.

Examples

Copy Text To Clipboard

None published. Please look for an example in the Scenome Scripting Language code base.