GetBinaryData |
  
|
GetBinaryData |
|
Retrieves data of a Binary item.
Note: This function returns the binary item data in an array. The array object will automatically be resized to fit the data. If the binary data size is not divisible the the vector element size an error will be returned.
Variants throwing exceptions on API errors:
generic <typename T>
void GetBinaryData(Out array<T> destinationBuffer, Out int numBytesCopied, Out double timestamp)
void GetBinaryDataByte(Out array<Byte> destinationBuffer, Out int numBytesCopied, Out double timestamp)
void GetBinaryDataShort(Out array<Short> destinationBuffer, Out int numBytesCopied, Out double timestamp)
void GetBinaryDataFloat(Out array<Float> destinationBuffer, Out int numBytesCopied, Out double timestamp)
Variants returning API errors as int parameter:
generic <typename T>
void GetBinaryData(Out int returnCode, Out array<T> destinationBuffer, Out int numBytesCopied, Out double timestamp)
void GetBinaryDataByte(Out int returnCode, Out array<Byte> destinationBuffer, Out int numBytesCopied, Out double timestamp)
void GetBinaryDataShort(Out int returnCode, Out array<Short> destinationBuffer, Out int numBytesCopied, Out double timestamp)
void GetBinaryDataFloat(Out int returnCode, Out array<Float> destinationBuffer, Out int numBytesCopied, Out double timestamp)
returnCode |
The error code returned when accessing the item. |
destinationBuffer |
The array where the binary data will be copied to. The function will take care of allocating an array object of sufficient size. |
numBytesCopied |
Pointer to an integer, can be 0. If non-zero the value will be set to the number of bytes actually copied to the user's buffer. |
timestamp |
Timestamp when the binary blob was generated. This pointer can be set to zero when the time stamp should not be retrieved. |
none