Share via

BthSSPAbortPairing (Compact 7)

  • Article

3/12/2014

This function may be used to end a Bluetooth pairing procedure that is currently in progress.

Syntax

DWORD BthSSPAbortPairing(
   __in const BT_ADDR *RemoteDevice
);

Parameters

  • RemoteDevice
    [in] Points to BT_ADDR that stores the address of the peer device with which pairing should be ended.

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

This function is the equivalent of a call to BthSSPPINCodeRequestReply with pPin set to NULL, BthSSPUserConfirmationRequestReply with UserAccepted set to FALSE, or BthSSPUserPasskeyRequestReply with HavePasskey set to FALSE, depending on the kind of authentication currently in progress. This function has no effect if the device is not in a state in which it is waiting for the user to enter a PIN, passkey, or confirmation.

The application must call this function or BthSSPPINCodeRequestReply in response to a BTE_SSP_PIN_CODE_REQUEST_EVENT event.

Requirements

Header

bt_api.h

Library

Btdrt.lib

See Also

Reference

Bluetooth API SSP Functions