niBTSG_ResetSession
- Updated2025-10-13
- 1 minute(s) read
Resets all the attributes of the session to their default values.
Syntax
int32 __stdcall niBTSG_ResetSession(niBTSGSession session)
Parameters
| Name | Direction | Type | Description |
|---|---|---|---|
| session | [out] | 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. |
Returns
Returns the status code of this operation. The status code either indicates success or describes an error or warning. Examine the status code from each call to an niBT SG function to determine if an error has occurred. To obtain a text description of the status code and additional information about the error condition, call the niBTSG_GetErrorString function. The general meaning of the status code is as follows:
Value | Meaning |
|---|---|
0 | Success |
Positive Values | Warnings |
Negative Values | Errors |