niBTSG_GetErrorString
- Updated2025-10-13
- 1 minute(s) read
Takes the error code returned by niBT generation functions and returns the interpretation as a user-readable string.
Syntax
int32 __stdcall niBTSG_GetErrorString(niBTSGSession session, int32 errorCode, int32 errorMessageLength, ViChar errorMessage)
Parameters
| Name | Direction | Type | Description |
|---|---|---|---|
| session | [in] | niBTSGSession | Specifies the niBT SG session. Use this parameter to configure the behavior and operation of the appropriate RFmx BT Generation function that accepts the niBTSGSession as an input. |
| errorCode | [in] | int32 | Specifies the error code that is returned by any of the niBT generation functions. |
| errorMessageLength | [in] | int32 | Specifies the length of the errorMessage buffer. |
| errorMessage | [in] | ViChar | Returns the user-readable message string that corresponds to the error code you specify. The errorMessage buffer must have at least as many elements as are indicated in the errorMessageLength parameter. If you pass NULL to the errorMessage parameter, the function returns the actual length of the error message. |
Returns
Returns the actual length of the error message string.