niSE_ExpandRouteSpec
- Updated2023-02-21
- 2 minute(s) read
niSE_ExpandRouteSpec
Expands a route spec string to yield more information about the routes and route groups within the spec.
Function Prototype
| NISEStatus __stdcall niSE_ExpandRouteSpec( | NISESession sessionHandle, |
| NISEConstString routeSpec, | |
| NISEInt32 expandAction, | |
| NISEBuffer * expandedRouteSpec, | |
| NISEInt32 * expandedRouteSpecSize); |
Parameters
Input
| Name | Type | Description |
|---|---|---|
| sessionHandle | NISESession | The session referencing this NI Switch Executive virtual device session. |
| routeSpec | String | The routes or route groups to be expanded. Refer to Route Specification Strings for more information. |
| expandAction | NISEExpandAction | The mode can be one of the following:
|
Output
| Name | Type | Description |
|---|---|---|
| expandedRouteSpec | NISEBuffer* | The expanded routes and route groups. Refer to Route Specification Strings for more information. |
| expandedRouteSpecSize | NISEInt32 | The expandedRouteSpecSize is an NISEInt32 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_ExpandRouteSpec Details
Use this function in conjunction with niSE_GetAllConnections to return the details of the currently connected routes and route groups. Then select, display, or error check what routes, devices, paths, and channels are currently connected based on the route details.