niSE_GetAllConnections
- Updated2023-02-21
- 1 minute(s) read
Returns all connected routes and route groups.
Function Prototype
| Function niSE_GetAllConnections( | sessionHandle As NISESession, |
| routeSpec As String, | |
| routeSpecSize As Long) As NISEStatus |
Parameters
Input
| Name | Type | Description |
|---|---|---|
| sessionHandle | NISESession | The session referencing this NI Switch Executive virtual device session. |
Output
| Name | Type | Description |
|---|---|---|
| routeSpec | String | The currently connected routes and route groups. Refer to Route Specification Strings for more information. |
| routeSpecSize | Long | The routeSpecSize is a Long that is passed by reference into the function. As an input, it is the size of the route string buffer being passed. If the route string is larger than the string buffer being passed, only the portion of the route string that can fit in the string buffer is copied into it. On return from the function, routeSpecSize holds the size required to hold the entire route string. This size may be larger than the buffer size as the function always returns the size needed to hold the entire buffer. You can pass NULL for this parameter if you are not interested in the return value for routeSpecSize and routeSpec. |
niSE_GetAllConnections Details
You can pass the routeSpec to other functions that take a routeSpec as input, such as niSE_Connect, niSE_Disconnect, and niSE_ExpandRouteSpec.