BthSetSSRParameters (Compact 2013)

3/26/2014

This function sets the parameters for sniff subrating (SSR) mode.

Syntax

int BthSetSSRParameters(
    BT_ADDR         *pba,
    unsigned short  ssr_max_latency,
    unsigned short  ssr_min_remote_timeout,
    unsigned short  ssr_min_local_timeout
);

Parameters

  • pba
    [in] Points to the address that identifies the connection on which the properties are to be set.
  • ssr_max_latency
    [in] The maximum remote latency in Baseband slots (0.625 milliseconds). Zero specifies no Link Supervision Timeout (LSTO). The value can range from 0x0001 through 0xFFFF representing 0.625 ms through 40.9 seconds.
  • ssr_min_remote_timeout
    [in] The minimum remote timeout in Baseband slots (0.625 milliseconds). Zero specifies no LSTO. The value can range from 0x0001 through 0xFFFF representing 0.625 ms through 40.9 seconds.
  • ssr_min_local_timeout
    [in] The minimum local timeout in Baseband slots (0.625 milliseconds). Zero specifies no LSTO. The value can range from 0x0001 through 0xFFFF representing 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.

Requirements

Header

bt_api.h

Library

Btdrt.lib

See Also

Reference

Bluetooth API Management Functions