BthReadPageTimeout (Compact 2013)

3/26/2014

This function retrieves the current page timeout value.

Syntax

int BthReadPageTimeout(
  unsigned short *ptimeout
);

Parameters

  • ptimeout
    [in] Pointer to the current page timeout value. The page timeout is measured in the number of Baseband slots (0.625 milliseconds). The timeout value can range from 0x0001 through 0xFFFF and represents 0.625 ms through 40.9 seconds.

Return Value

The following table shows the possible return values.

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

For more information, see "Read Page Timeout" in the Core Specification v2.1 + EDR on the Bluetooth website.

Note

To preserve Microsoft Win32 compatibility, consider using the Winsock equivalent of this function. To do so, set the optname parameter in the getsockopt function to SO_BTH_GET_PAGE_TO.

Requirements

Header

bt_api.h

Library

Btdrt.lib

See Also

Reference

Bluetooth API Management Functions
Bluetooth AG Service Functions