niSE_GetError
- Updated2023-02-21
- 1 minute(s) read
niSE_GetError
Queries for and returns the most recent error.
Function Prototype
| NISEStatus __stdcall niSE_GetError( | NISESession sessionHandle, |
| NISEStatus * errorNumber, | |
| NISEBuffer* errorDescription, | |
| NISEInt32 * errorDescriptionSize); |
Parameters
Input
| Name | Type | Description |
|---|---|---|
| sessionHandle | NISESession | The session referencing this NI Switch Executive virtual device session. |
Input/Output
| Name | Type | Description | ||
|---|---|---|---|---|
| errorDescriptionSize | NISEInt32 | The errorDescriptionSize is an NISEInt32 that is passed by reference into the
function.
As an input, it is the size of the error description buffer being passed. If the error description is larger than the error description buffer being passed, only the portion of the error description that can fit in the error description buffer is copied into it. On return from the function, errorDescriptionSize holds the size required to hold the entire error description.
You can pass NULL for this parameter if you are not interested in the return value for errorDescriptionSize and errorDescription. |
Output
| Name | Type | Description |
|---|---|---|
| errorNumber | NISEStatus | The error code. |
| errorDescription | NISEBuffer | Description of the error. |
To dynamically allocate space for the errorDescription buffer, call niSE_GetError twice. The first call should specify a errorDescriptionSize of 0 and then use the returned errorDescriptionSize to allocate the correct buffer size.