NI-HSDIO C Function Reference

niHSDIO_error_message

  • Updated2023-02-21
  • 1 minute(s) read

ViStatus = niHSDIO_error_message ( ViSession vi, ViStatus errorCode, ViChar errorMessage[256]);

Purpose

Takes the error code returned by the instrument driver functions, interprets it, and returns it as a user readable string.

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi was obtained from the niHSDIO_InitAcquisitionSession or niHSDIO_InitGenerationSession function.
Error Code ViStatus The error code returned from the device.
Output
Name Type Description
Error String ViChar[ ] Returns the message string.

Note  The string must contain at least 256 characters.

Return Value

Name Type Description
Status ViStatus

Reports the status of this operation. To obtain a text description of the status code, call the niHSDIO_error_message function. To obtain additional information concerning the error condition, use the niHSDIO_GetError and niHSDIO_ClearError functions.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Log in to get a better experience