niFgen_DeleteScript
ViStatus niFgen_DeleteScript (ViSession vi, ViConstString channelName, ViConstString scriptName);
Purpose
Deletes the specified script from onboard memory.
Parameters
| Input | ||
| Name | Type | Description |
| vi | ViSession | Identifies your instrument session. vi is obtained from the niFgen_init or the niFgen_InitWithOptions functions and identifies a particular instrument session. |
| channelName | ViConstString | Specifies the channel onto which the script is loaded.
Default Value: "0" |
| scriptName | ViConstString | Specifies the name of the script you want to delete. The script name appears in the text of the script following the script keyword. |
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. You can examine the status code from each call to an NI-FGEN function to determine if an error occurred.
To obtain a text description of the status code, call the niFgen_error_message function. To obtain additional information about the error condition, call the niFgen_GetError function. To clear the error information from NI-FGEN, call the niFgen_ClearError function. The general meaning of the status code is as follows:
|