INDICATION_PARAMETERS structure (bthddi.h)
The INDICATION_PARAMETERS structure is passed as the Parameters parameter to a profile driver's L2CAP Callback Function
Syntax
typedef struct _INDICATION_PARAMETERS {
L2CAP_CHANNEL_HANDLE ConnectionHandle;
IN BTH_ADDR BtAddress;
union {
struct {
struct {
OUT USHORT PSM;
} Request;
} Connect;
struct {
CHANNEL_CONFIG_PARAMETERS CurrentParams;
CHANNEL_CONFIG_PARAMETERS RequestedParams;
CHANNEL_CONFIG_PARAMETERS ResponseParams;
USHORT Response;
} ConfigRequest;
struct {
CHANNEL_CONFIG_PARAMETERS CurrentParams;
CHANNEL_CONFIG_PARAMETERS RequestedParams;
CHANNEL_CONFIG_PARAMETERS RejectedParams;
PCO_TYPE UnknownTypes;
ULONG NumUnknownTypes;
CHANNEL_CONFIG_PARAMETERS NewRequestParams;
USHORT Response;
} ConfigResponse;
struct {
ULONG NumExtraOptions;
PL2CAP_CONFIG_OPTION ExtraOptions;
} FreeExtraOptions;
struct {
L2CAP_DISCONNECT_REASON Reason;
BOOLEAN CloseNow;
} Disconnect;
struct {
ULONG PacketLength;
ULONG TotalQueueLength;
} RecvPacket;
} Parameters;
} *PINDICATION_PARAMETERS, INDICATION_PARAMETERS;
Members
ConnectionHandle
The L2CAP connection handle to the remote device. This handle is only valid for notifications that arrive over an established L2CAP connection.
BtAddress
The Bluetooth address of the remote device.
Parameters
Parameters.Connect
The structure that contains parameters for the IndicationRemoteConnect callback function.
Parameters.Connect.Request
The structure that contains the parameters for a connection request.
Parameters.Connect.Request.PSM
The Protocol/Service Multiplexer (PSM) that is passed to the calling function when the IndicationRemoteConnectINDICATION_CODE value is specified in the callback function's Indication parameter.
Parameters.ConfigRequest
The structure that contains parameters for the IndicationRemoteConfigRequestINDICATION_CODE value.
Parameters.ConfigRequest.CurrentParams
A CHANNEL_CONFIG_PARAMETERS structure that contains the parameters for the current channel. This value is only valid if the channel was previously open and is now in the process of being configured. This member is used when the callback function specifies the IndicationRemoteConfigRequestINDICATION_CODE value.
Parameters.ConfigRequest.RequestedParams
A CHANNEL_CONFIG_PARAMETERS structure that contains the parameters that are passed from the remote host for configuration requests. This member is used when the callback function specifies the IndicationRemoteConfigRequestINDICATION_CODE value.
Parameters.ConfigRequest.ResponseParams
A CHANNEL_CONFIG_PARAMETERS structure that contains the parameters that the profile driver responds to the configuration request with.
Parameters.ConfigRequest.Response
A flag that indicates the status of the configuration request. Valid flag values are listed in the following table.
| Flag | Description |
|---|---|
| CONFIG_STATUS_SUCCESS | The configuration request was successful. |
| CONFIG_STATUS_DISCONNECT | The configuration request failed because the L2CAP connection was disconnected. |
| CONFIG_STATUS_INVALID_PARAMETER | The configuration request failed because an invalid parameter was passed to the profile driver. |
| CONFIG_STATUS_REJECT | The profile driver rejected the configuration request. |
| CONFIG_STATUS_UNKNOWN_OPTION | The configuration request failed because one of the specified configuration options was not recognized by the profile driver. |
Parameters.ConfigResponse
The structure that contains parameters for the IndicationRemoteConfigResponseINDICATION_CODE value.
Parameters.ConfigResponse.CurrentParams
A CHANNEL_CONFIG_PARAMETERS structure that contains the parameters for the current channel. This value is only valid if the channel was previously open and is now in the process of being configured. This member is used when the callback function specifies the IndicationRemoteConfigRequestINDICATION_CODE value.
Parameters.ConfigResponse.RequestedParams
A CHANNEL_CONFIG_PARAMETERS structure that contains the parameters that are passed from the remote host for configuration requests. This member is used when the callback function specifies the IndicationRemoteConfigRequestINDICATION_CODE value.
Parameters.ConfigResponse.RejectedParams
A *CHANNEL_CONFIG_PARAMETERS structure that contains the configuration parameter settings that were rejected by the remote device.
Parameters.ConfigResponse.UnknownTypes
An array of types that were not recognized by the responding device.
Parameters.ConfigResponse.NumUnknownTypes
The number of unrecognized types in the UnknownTypes member.
Parameters.ConfigResponse.NewRequestParams
A *CHANNEL_CONFIG_PARAMETERS structure that contains the parameter settings for the callback function to resubmit after the response has returned from the remote device.
Parameters.ConfigResponse.Response
A flag that indicates the status of the configuration request. Valid flag values are listed in the following table.
| Flag | Description |
|---|---|
| CONFIG_STATUS_SUCCESS | The configuration request was successful. |
| CONFIG_STATUS_DISCONNECT | The configuration request failed because the L2CAP connection was disconnected. |
| CONFIG_STATUS_INVALID_PARAMETER | The configuration request failed because an invalid parameter was passed to the profile driver. |
| CONFIG_STATUS_REJECT | The profile driver rejected the configuration request. |
| CONFIG_STATUS_UNKNOWN_OPTION | The configuration request failed because one of the specified configuration options was not recognized by the profile driver. |
Parameters.FreeExtraOptions
The structure that contains parameters for the IndicationFreeExtraOptionsINDICATION_CODE value.
Parameters.FreeExtraOptions.NumExtraOptions
The number of extra options contained in the ExtraOptions member.
Parameters.FreeExtraOptions.ExtraOptions
The number of extra options contained in the ExtraOptions member.
Parameters.Disconnect
The structure that contains the parameters for the IndicationRemoteDisconnectINDICATION_CODE value.
Parameters.Disconnect.Reason
An L2CAP_DISCONNECT_REASON value that indicates why the L2CAP connection to the remote device was terminated.
Parameters.Disconnect.CloseNow
A Boolean value that a profile driver uses to notify the Bluetooth driver stack to close the L2CAP connection. Set this member to TRUE to notify the Bluetooth driver stack to close the connection. Otherwise, set it to FALSE to keep the connection open.
Parameters.RecvPacket
The structure that contains the parameters for the IndicationRecvPacketINDICATION_CODE value.
Parameters.RecvPacket.PacketLength
The size, in bytes, of the packet that the callback function sent over the L2CAP connection.
Parameters.RecvPacket.TotalQueueLength
The number of packets to be processed over the L2CAP connection.
Remarks
A profile driver's L2CAP Callback Function should process this structure 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 IndicationRemoteConnect, the callback function should use the Connect member of the Parameters union.
When the Bluetooth driver stack passes IndicationRemoteDisconnect, the callback function should use the Disconnect member of the Parameters union.
When the Bluetooth driver stack passes IndicationRemoteConfigRequest, the callback function should use the ConfigRequest member of the Parameters union.
When the Bluetooth driver stack passes IndicationRemoteConfigResponse, the callback function should use the ConfigResponse member of the Parameters union.
When the Bluetooth driver stack passes IndicationRemoteFreeExtraOptions, the callback function should use the FreeExtraOptions member of the Parameters union.
When the Bluetooth driver stack passes IndicationRemoteRecvPacket, the callback function should use the RecvPacket member of the Parameters union.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Versions:_Supported in Windows Vista, and later. |
| Header | bthddi.h (include Bthddi.h) |