Edit

WWAN_SET_CONTEXT_STATE structure (wwan.h)

  • Article

The WWAN_SET_CONTEXT_STATE structure represents the command to set the Packet Data Protocol (PDP) context state of the MB device.

Syntax

typedef struct _WWAN_SET_CONTEXT_STATE {
  ULONG                     ConnectionId;
  WWAN_ACTIVATION_COMMAND   ActivationCommand;
  WCHAR                     AccessString[WWAN_ACCESSSTRING_LEN];
  WCHAR                     UserName[WWAN_USERNAME_LEN];
  WCHAR                     Password[WWAN_PASSWORD_LEN];
  WWAN_COMPRESSION          Compression;
  WWAN_AUTH_PROTOCOL        AuthType;
  WWAN_IP_TYPE              IPType;
  WWAN_PSMEDIA_PREFERENCE   MediaPreference;
  WWAN_CONFIGURATION_SOURCE ConnectionMediaSource;
  WWAN_ACTIVATION_OPTION    ActivationOption;
  WWAN_SINGLE_NSSAI         Snssai;
  WWAN_OFFSET_SIZE_ELEMENT  TrafficParameters;
} WWAN_SET_CONTEXT_STATE, *PWWAN_SET_CONTEXT_STATE;

Members

ConnectionId

MB Service specifies this member to uniquely identify the PDP Context and its corresponding state.

The MB Service uses the value in this member to uniquely identify the current active context across MB network adapters.

The miniport driver must use the value in this member when completing set requests. The MB Service uses the value in this member in subsequent query requests as well as disconnect requests to the miniport driver.

ActivationCommand

Activate or deactivate a PDP context that is referenced in the ConnectionId member. The following table shows the possible values a miniport driver can specify.

Value Meaning
WwanActivationCommandActivate Activate PDP context referred to by ConnectionId .
WwanActivationCommandDeactivate Deactivate a currently activated PDP context referred by ConnectionId .

AccessString[WWAN_ACCESSSTRING_LEN]

A NULL-terminated string to access the network. For GSM-based networks, this would be an Access Point Name (APN) string such as "data.thephone-company.com". For CDMA-based networks, this might be a special dial code such as "#777" or a Network Access Identifier (NAI) such as "foo@thephone-company.com". This member can be NULL.

The size of the string should not exceed 100 bytes.

UserName[WWAN_USERNAME_LEN]

A NULL-terminated string that represents the username to authenticate. This member can be NULL.

Password[WWAN_PASSWORD_LEN]

A NULL-terminated string that represents the username's password. This member can be NULL.

Compression

A value from the WWAN_COMPRESSION enumeration that specifies whether compression should be used in the data connection for header and data. This member applies only to GSM-based devices. The MB Service sets this member to WwanCompressionNone for CDMA-based devices.

Value Meaning
WwanCompressionNone No compression is applied.
WwanCompressionEnable Enable header and data compression.

AuthType

A value from the WWAN_AUTH_PROTOCOL enumeration that specifies the authentication type to use for the PDP activation. This member applies only to GSM-based devices. The MB Service sets this member to WwanAuthProtocolNone for CDMA-based devices.

Value Meaning
WwanAuthProtocolNone No authentication protocol.
WwanAuthProtocolPap Unencrypted password authentication.
WwanAuthProtocolChap Use the Challenge Handshake Authentication Protocol (CHAP).
WwanAuthProtocolMsChapV2 Use the Microsoft Challenge Handshake Authentication Protocol (CHAP) v2.0.

IPType

A value from the WWAN_IP_TYPE enumeration that specifies the type of IP.

MediaPreference

ConnectionMediaSource

ActivationOption

A value from the WWAN_ACTIVATION_OPTION enumeration that represents the Packet Data Protocol (PDP) activation options that the MB device supports.

Snssai

A WWAN_SINGLE_NSSAI structure representing a single Network Slice Selection Assistance Information (NSSAI).

TrafficParameters

A WWAN_OFFSET_SIZE_ELEMENT structure. The first 4 bytes are the offset to the DataBuffer containing the raw data of MBIM_TLV_TYPE_TRAFFIC_PARAMETERS data field, in bytes, calculated from the beginning of WWAN_SET_CONTEXT_STATE. The second 4 bytes are size of the raw data of MBIM_TLV_TYPE_TRAFFIC_PARAMETERS data field, in bytes.

Requirements

Requirement Value
Minimum supported client Available in Windows 8 and later versions of Windows.
Header wwan.h (include Wwan.h)

See also

NDIS_WWAN_SET_CONTEXT_STATE

WWAN_ACTIVATION_COMMAND

WWAN_AUTH_PROTOCOL

WWAN_COMPRESSION