Share via


BthSSPPINCodeRequestReply (Compact 2013)

3/26/2014

This function passes a user-entered PIN code to the Bluetooth stack in response to a PIN Code Request event.

Syntax

DWORD BthSSPPINCodeRequestReply(
    __in      const BT_ADDR *RemoteDevice,
    __in_opt  const BYTE    *pPin, 
    __in            UINT     cbPin
);

Parameters

  • RemoteDevice
    [in] Pointer to the address of the remote device.
  • pPin
    [in, optional] Pointer to the user-entered PIN code. If no PIN code is available set to NULL.
  • cbPin
    [in] Length, in bytes, of the user-entered PIN code. If no PIN code is available set to zero (0).

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

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

After the devices are paired, the application typically deletes the PIN code stored by the Bluetooth stack by calling BthRevokePIN.

Requirements

Header

bt_api.h

Library

Btdrt.lib

See Also

Reference

Bluetooth API SSP Functions
BT_SSP_PIN_CODE_REQUEST_EVENT
BthSSPAbortPairing