imaqReadCustomData
Usage
void* imaqReadCustomData(const Image* image, const char* key, unsigned int* size);
Purpose
Reads the custom data associated with a key in an image.
Image Types Supported
IMAQ_IMAGE_U8, IMAQ_IMAGE_U16, IMAQ_IMAGE_I16, IMAQ_IMAGE_SGL, IMAQ_IMAGE_COMPLEX, IMAQ_IMAGE_RGB, IMAQ_IMAGE_HSL, IMAQ_IMAGE_RGB_U64
Parameters
Name
|
Type
|
Description
|
---|---|---|
image | const Image* | The image that has the data to read. |
key | const char* | The key used to find the data in the image. |
size | unsigned int* | On return, the size of the data, in bytes. Set this parameter to NULL if you do not need this information. |
Return Value
Type |
Description |
---|---|
void* | If the key is found in the image, this function returns a copy of the data associated with that key. When you are finished with this data, dispose of it by calling imaqDispose(). |