BthWritePageTimeout (Compact 2013)
3/26/2014
This function configures the page time-out.
Syntax
int BthWritePageTimeout(
unsigned short timeout
);
Parameters
- timeout
[in] The page time-out in Baseband slots (0.625 milliseconds). The value can range from 0x0001 through 0xFFFF and represents 0.625 ms through 40.9 seconds. The default setting is 0x2000, or 5.12 seconds.
Return Value
Value |
Description |
---|---|
ERROR_SUCCESS |
Success. |
ERROR_SERVICE_NOT_ACTIVE |
The Bluetooth stack is not present. |
Other standard HRESULT error codes may be returned as appropriate.
Remarks
The page time-out is not persistent. It reverts to the default setting when the controller is reinitialized; for example, when it is reinserted or the device is powered down.
For more information, see "Write Page Timeout" in the Core Specification v2.1 + EDR on the Bluetooth web site.
Note
To preserve Microsoft Win32 compatibility, consider using the Winsock equivalent of this function. To do so, set the optname parameter in the setsockopt function to SO_BTH_SET_PAGE_TO.
Requirements
Header |
bt_api.h |
Library |
Btdrt.lib |
See Also
Reference
Bluetooth API Management Functions
Bluetooth AG Service Functions