viClose
Purpose
Closes the specified session, event, or find list.
C Syntax
ViStatus viClose(ViObject vi)
Visual Basic Syntax
viClose&(ByVal vi&)
Resource Classes
All I/O session types, all event object types, VISA Resource Manager
Parameters
| Name | Direction | Description |
|---|---|---|
|
vi |
IN |
Unique logical identifier to a session, event, or find list. |
Return Values
| Completion Codes | Description |
|---|---|
|
VI_SUCCESS |
Session closed successfully. |
|
VI_WARN_NULL_OBJECT |
The specified object reference is uninitialized. |
| Error Codes | Description |
|---|---|
|
VI_ERROR_INV_OBJECT |
The given object reference is invalid. |
|
VI_ERROR_CLOSING_FAILED |
Unable to deallocate the previously allocated data structures corresponding to this session or object reference. |
Description
The viClose() operation closes a session, event, or a find list. In this process all the data structures that had been allocated for the specified vi are freed. Calling viClose() on a VISA Resource Manager session will also close all I/O sessions associated with that resource manager session.
Related Topics