NI-TClk C Function Reference

niTClk_GetExtendedErrorInfo

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

Specific Function

ViStatus niTClk_GetExtendedErrorInfo (ViChar errorString [], ViUInt32 errorStringSize);

Purpose

Reports extended error information for the most recent NI-TClk function that returned an error.

To determine the function that returned an error, use the return values of the individual functions. After the niTClk_GetExtendedErrorInfo function reports an errorString, this function does not report an empty string again.

Parameters

Input
Name Type Description
errorString ViChar [] Extended error description. If errorString is NULL, then the string is not large enough to hold the entire error description. In this case, niTClk_GetExtendedErrorInfo returns the size of the full error string, which can be used with niTClk_GetExtendedErrorInfo to retrieve the full error string.
errorStringSize ViUInt32 Size of errorString. If errorStringSize is 0, then it is not large enough to hold the entire error description. In this case, niTClk_GetExtendedErrorInfo returns the size of the full error string, which can be used with niTClk_GetExtendedErrorInfo to retrieve the full error string.

Return Value