niSwitch_ClearError

NI Switches Help

Edition Date: April 2015

Part Number: 375472H-01

»View Product Info
Download Help (Windows Only)

Specific Function

C Function Prototype

ViStatus niSwitch_ClearError (ViSession vi);

Purpose

This function clears the error code and error description for the IVI session.
If you specify a valid IVI session for the vi parameter, this function clears the error information for the session.

If the user passes VI_NULL for the vi parameter, this function clears the error information for the current execution thread.
If vi is an invalid session, the function does nothing and returns an error. The function clears the error code by setting it to VI_SUCCESS,

If the error description string is non-NULL, the function deallocates the error description string and sets the address to VI_NULL.

Maintaining the error information separately for each thread is useful if the user does not have a session handle to pass to the niSwitch_GetError function, which occurs when a call to niSwitch_init or niSwitch_InitWithOptions fails.

Parameters

Name Type Description
vi ViSession A particular NI-SWITCH session established with niSwitch_InitWithTopology, niSwitch_InitWithOptions, or niSwitch_init and used for all subsequent NI-SWITCH calls.

Related Information

WAS THIS ARTICLE HELPFUL?

Not Helpful