niFgen_close
ViStatus niFgen_close (ViSession vi);
Purpose
Performs the following operations:
- Closes the instrument I/O session.
- Destroys the NI-FGEN session and all of its attributes.
- Deallocates any memory resources NI-FGEN uses.
Not all signal routes established by calling the niFgen_ExportSignal and niFgen_RouteSignalOut functions are released when the NI-FGEN session is closed. The following table shows what will happen to a signal route on your device when the NI-FGEN session is closed.
| Routes To |
NI 5401/5411/5431 | Other |
|---|
| Front Panel |
Remain connected | Remain connected |
| RTSI/PXI Backplane |
Remain connected | Disconnected |
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. |
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:
| Value |
Meaning |
| 0 |
Success |
| Positive Values |
Warnings |
| Negative Values |
Errors |
|
