niSync_error_message

C Function Prototype

ViStatus niSync_error_message (ViSession vi, ViStatus errorCode, ViChar[] errorMessage);

Purpose

Converts an error or warning code returned by an NI-Sync driver function into a user-readable string.

Parameters

Name Type Description
vi ViSession The session handle that you obtain from niSync_init. The handle identifies a particular instrument session.

You can pass VI_NULL for this parameter. This is useful when one of the initialize functions fail.

errorCode ViStatus The error code to be explained in a user-readable string. Pass the Status parameter that is returned from any of the instrument driver functions to use this parameter.

Default Value: 0 (VI_SUCCESS)

errorMessage ViChar[] Returns a user-readable message string. This string explains the error code specified in errorCode.

You must pass a ViChar array at least 256 bytes in size.

Return Values