ni-rfsg-c-api-ref-doc

niRFSG_CheckIfScriptExists

  • Updated2024-05-08
  • 1 minute(s) read

niRFSG_CheckIfScriptExists

C Function Prototype

ViStatus niRFSG_CheckIfScriptExists (ViSession vi, ViConstString scriptName, ViBoolean* scriptExists);

Purpose

Returns whether the script that you specify as scriptName exists.

Supported Devices: PXIe-5673/5673E

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session.
scriptName ViConstString Specifies the name of the script. This string is case-insensitive.

Output
Name Type Description
scriptExists ViBoolean* Returns VI_TRUE if the script exists.

Defined Values:
VI_TRUEThe script exists.
VI_FALSE The script does not exist.

Return Value

Name Type Description
status ViStatus Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an instrument driver function to determine if an error occurred.

To obtain a text description of the error code, call the niRFSG_GetError function.

The general meaning of the status code is as follows:

ValueMeaning
0Success
Positive ValuesWarnings
Negative ValuesErrors

Log in to get a better experience