collapse_allSyntax

Top  Previous  Next

 

Boonton55xxx IVI Driver Reference


 

Btn55xxx_GetError Function


Utility See Also



This function retrieves and then clears the IVI error information for the session or the current execution thread. If the user specifies a valid IVI session for the Vi parameter, Get Error retrieves and then clears the error information for the session. If the user passes VI_NULL for the Vi parameter, Get Error retrieves and then clears the error information for the current execution thread. If the Vi parameter is an invalid session, the function does nothing and returns an error. Normally, the error information describes the first error that occurred since the user last called the Get Error or Clear Error function.

Function Tree Node: \Boonton55xxx\Utility\Get Error

Declaration: Btn55xxx.h

Implementation: Btn55xxx.dll

Visual C++

ViStatus Btn55xxx_GetError(
 ViSession Vi,
 ViStatusErrorCode,
 ViInt32 ErrorDescriptionBufferSize,
 ViChar[] ErrorDescription
);

Parameters

Vi

The ViSession handle that you obtain from the IviDriver_init or IviDriver_InitWithOptions function. The handle identifies a particular instrument session.

ErrorCode

Returns the error code. Zero indicates that no error occurred. A positive value indicates a warning. A negative value indicates an error. The user can pass VI_NULL if the user does not want to retrieve this value.

ErrorDescriptionBufferSize

The number of bytes in the ViChar array that the user specifies for the ErrorDescription parameter.

ErrorDescription

Buffer into which the function copies the full formatted error string. The string describes the error code and any extra information regarding the error or warning condition. The buffer shall contain at least as many bytes as the user specifies in the ErrorDescriptionBufferSize parameter. The user can pass VI_NULL if the ErrorDescriptionBufferSize parameter is zero.

Return Value

 

Success or failure code.

collapse_allSee Also

Reference

Utility

Btn55xxx

Footer image

Copyright 2013-16 Boonton. All rights reserved.