Share via

BthWritePageTimeout

  • Article

This function configures the page timeout.

Note   To preserve Win32 compatibility, consider using the Winsock equivalent of this function. To do so, pass SO_BTH_SET_PAGE_TO as the optname value in setsockopt.

int BthWritePageTimeout(
  unsigned short timeout
);

Parameters

  • timeout
    [in] Specifies the page timeout. The page timeout is measured in the number of baseband slots, and must be larger than zero (0). A valid page timeout is N = 0xXXXX. The default setting is N = 0x2000, or 5.12 seconds. The valid range is 0x0001 to 0xFFFF.

    The interval length is equal to N * 0.625 msec, or 1 Baseband slot. The valid time range is 0.625 msec to 40.9 Seconds.

Return Values

This function returns ERROR_SUCCESS when it completes successfully. A return value of ERROR_SERVICE_NOT_ACTIVE indicates that the hardware is not inserted or that the Bluetooth stack is not present.

Other standard error codes may be returned as appropriate.

Remarks

The page timeout is not persistent. It reverts to the default setting when the adapter is reinitialized, for example, when it is reinserted or the device is powered down.

For more information about this function, see the Write_Page_Timeout part of the Bluetooth Core Specification.

Requirements

OS Versions: Windows CE .NET 4.2 and later.
Header: Bt_api.h.
Link Library: Btdrt.lib.

See Also

Bluetooth Platform Development Functions | Bluetooth

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.