Share via


BthReadPageTimeout (Windows Embedded CE 6.0)

1/6/2010

This function retrieves the current page timeout value.

Note

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

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. The page timeout is N = 0xXXXX, with a valid range of 0x0001 to 0xFFFF.

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

Return Value

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

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

Requirements

Header bt_api.h
Library Btdrt.lib
Windows Embedded CE Windows CE .NET 4.2 and later

See Also

Reference

Bluetooth OS Functions

Other Resources

Bluetooth Application Development