Share via

BthSSPSetRemoteOOBData (Compact 2013)

  • Article

3/26/2014

This function provides out-of-band (OOB) data to the local Bluetooth stack.

Syntax

DWORD BthSSPSetRemoteOOBData(
    __in const BT_ADDR      *RemoteDevice,
    __in const BTSSPOOBData *pData
);

Parameters

  • RemoteDevice
    [in] Pointer to the address of the remote device that supplied the OOB data.
  • pData
    [in] Pointer to a BTSSPOOBData structure that contains the OOB data to be saved, or NULL if existing OOB data is to be deleted.

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.

Remarks

An application uses this function to save the OOB data that it receives from a peer Bluetooth device through an out-of-band mechanism.

Until the application calls this function, no OOB data is present in the local Bluetooth stack.

OOB data is only required during pairing. After pairing is complete, the application typically calls this function with pData set to NULL to delete the OOB data received from the remote device.

Requirements

Header

bt_api.h

Library

Btdrt.lib

See Also

Reference

Bluetooth API SSP Functions
Bluetooth AG Service Functions
BthSSPGetRemoteOOBData
BthSSPReadLocalOOBData