SCO_INDICATION_PARAMETERS structure (bthddi.h)

The SCO_INDICATION_PARAMETERS structure describes indication parameters about a SCO connect or disconnect notification.

Syntax

typedef struct _SCO_INDICATION_PARAMETERS {
  SCO_CHANNEL_HANDLE ConnectionHandle;
  BTH_ADDR           BtAddress;
  union {
    struct {
      struct {
        SCO_LINK_TYPE LinkType;
      } Request;
    } Connect;
    struct {
      SCO_DISCONNECT_REASON Reason;
      BOOLEAN               CloseNow;
    } Disconnect;
  } Parameters;
} SCO_INDICATION_PARAMETERS, *PSCO_INDICATION_PARAMETERS;

Members

ConnectionHandle

A connection handle to the remote device. This handle is only valid for notifications that arrive over an established SCO connection.

BtAddress

The Bluetooth address of the remote device.

Parameters

Union of the following fields.

Parameters.Connect

The structure that contains parameters for the ScoIndicationRemoteConnectSCO_INDICATION_CODE event.

Parameters.Connect.Request

The structure that contains the parameters for the SCO connection request.

Parameters.Connect.Request.LinkType

A value from the SCO_LINK_TYPE enumeration that indicates the type of incoming connection.

Parameters.Disconnect

The structure that contains parameters for the ScoIndicationRemoteDisconnectSCO_INDICATION_CODE event.

Parameters.Disconnect.Reason

A SCO_DISCONNECT_REASON value that indicates why the SCO connection was terminated.

Parameters.Disconnect.CloseNow

A Boolean value that a profile driver can set to indicate whether the SCO connection to the remote device will be closed. If the connection is to be closed, the value is TRUE. Otherwise, the value is FALSE.

Remarks

A profile driver's SCO Callback Function should process a notification differently depending upon the value that the Bluetooth driver stack passes in the Indication parameter of the callback function.

When the Bluetooth driver stack passes ScoIndicationRemoteConnect, the callback function should use the Connect member of the Parameters union.

When the Bluetooth driver stack passes ScoIndicationRemoteDisconnect, the callback function should use the Disconnect member of the Parameters union.

Requirements

See also

SCO Callback Function

SCO_DISCONNECT_REASON