niBTSA_GetScalarAttributeI32
- Updated2023-02-21
- 1 minute(s) read
int32 __stdcall niBTSA_GetScalarAttributeI32 (niBTSASession session, char channelString[], niBTSA_Attr attributeID, int32 *value);
Purpose
Queries the value of an niBT SA 32-bit integer (int32) scalar attribute.
Parameters
| Input | ||
| Name | Type | Description |
| session | niBTSASession | Specifies the niBT SA session. Use this parameter to configure the behavior and operation of the appropriate NI Bluetooth Analysis Toolkit function that accepts the niBTSASession as an input. |
| channelString | char[] | Set this parameter to "" (empty string) or NULL. |
| attributeID | niBTSA_Attr | Specifies the ID of an int32 niBT SA scalar attribute. |
| Output | ||
| Name | Type | Description |
| value | int32* | Returns the value of the attribute that you specify using the attributeID parameter. |
Return Value
| Name | Type | Description | ||||||||
| status | int32 | 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 SA 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 niBTSA_GetErrorString function. The general meaning of the status code is as follows:
|
||||||||