BthSSPGetLocalOOBData (Compact 7)

  • Article

3/12/2014

This function creates out-of-band (OOB) Bluetooth pairing information for use by a peer device.

Syntax

DWORD BthSSPGetLocalOOBData(
  __out BTSSPOOBData *pData
);

Parameters

  • pData
    [out] Pointer to a BTSSPOOBData structure, which on return contains new OOB pairing data for the local device.

Return Value

The following table shows the possible return values.

Value Description

ERROR_SUCCESS

Success.

Remarks

Each time this function is called it generates new OOB data. The Bluetooth stack may transfer this data to a peer device and then both devices use the data in subsequent Bluetooth pairing and authentication procedures (for example, a call to BthAuthenticate).

The OOB data returned by this function is only valid until any of the following occur:

  • Authentication fails.
  • The Bluetooth baseband is reset.
  • This function is called again, generating new OOB data.

The invalid OOB data is useless to any peer device; the change in OOB data does not affect already-paired devices.

Requirements

Header

bt_api.h

Library

Btdrt.lib

See Also

Reference

Bluetooth API SSP Functions
BthSSPGetRemoteOOBData
BthSSPSetRemoteOOBData