imaqIOGetErrorText

Format

rval = imaqIOGetErrorText(IMAQIO_ERR errorCode, unsigned long* errorTextLength, char *errorText);

Purpose

Gets the error text associated with an error code.

Parameters

Name	Type	Direction
errorCode	IMAQIO_ERR	input
errorTextLength	unsigned long*	input/output
errorText	char*	output

Parameter Discussion

errorCode is the error code to get text for.

errorTextLength is the size of the buffer to store error text in. If errorTextLength is smaller than the buffer size you pass in here, IMAQIO_ERR_ERROR_TEXT_TOO_SHORT is returned. Regardless of whether an error occurs, this function returns the error text length in errorTextLength.

errorText is a pointer to a buffer to write the error text into.

Return Value

This function returns 0 on success. On failure, this function returns an error code. For information about the error code, call imaqIOGetErrorText.