SWI_STRUCT_GsmProfileBasic Struct Reference

#include <SwiApiGsmNetwork.h>

Data Fields
swi_uint32	sizeStruct
swi_uint8	nProfileId
swi_bool	bValid
enum SWI_TYPE_PDP	ePdpType
swi_bool	bDataCompression
swi_bool	bHeaderCompression
swi_bool	bAutomaticIP
swi_uint32	nLengthPdp
swi_uint8	byPdp [LENGTH_IPAddress]
swi_char	szAccessPoint [LENGTH_AccessPointName]
enum SWI_TYPE_PdpInitiated	ePdpInitiated
swi_uint32	nPrimaryProfileId
enum SWI_TYPE_Authentication	eAuthentication
swi_char	szUserName [LENGTH_UserName]
swi_char	szPassword [LENGTH_Password]
swi_char	szLabel [LENGTH_Label]
swi_uint32	nMaxUsernameLength
swi_uint32	nMaxPasswordLength
swi_bool	bAutoActivation
swi_bool	bReadOnly
swi_bool	bPromptPassword
swi_bool	bAutoRunVPN
swi_uint32	nLingerTimer
swi_uint8	nSoftwareOptions
swi_uint8	MccMnc [LENGTH_MCCMNC_BUFFER]
swi_uint8	Reserved [11]

Detailed Description

This object contains basic 3G GSM profile settings

This structure is used with 3G and newer devices.

See Also

SWI_TYPE_PDP

SWI_TYPE_PdpInitiated

SWI_TYPE_Authentication

SwiGetGsmProfileBasic

SwiSetGsmProfileBasic

SWI_NOTIFY_GsmProfileChange

Field Documentation

swi_bool SWI_STRUCT_GsmProfileBasic::bAutoActivation

True indicates that this account should be automatically connected if the profile is designated as default (see SwiSetDefaultProfile). False indicates the host software must manually request to connect with this account.

swi_bool SWI_STRUCT_GsmProfileBasic::bAutomaticIP

True indicates the IP address is to be manually assigned (dwPDPAddress), false indicates the IP address is to be dynamically assigned by the network. Note that DHCP is not necessarily exchanged over the air.

swi_bool SWI_STRUCT_GsmProfileBasic::bAutoRunVPN

True indicates to the host application a VPN client should be ran automatically after a successful connection is made. Otherwise, false is returned.

swi_bool SWI_STRUCT_GsmProfileBasic::bDataCompression

True indicates V.42bis is to be used for data, false indicates data compression is off. The carrier indicates if this is supported. It is always safe to leave as "false", although throughput may be reduced.

swi_bool SWI_STRUCT_GsmProfileBasic::bHeaderCompression

True indicates TCP header compression is on, false indicates header compression is off. The carrier indicates if this is supported. It is always safe to leave as "false", although throughput may be reduced.

swi_bool SWI_STRUCT_GsmProfileBasic::bPromptPassword

True is returned if the user should be prompted to enter a password. Otherwise, false is returned.

swi_bool SWI_STRUCT_GsmProfileBasic::bReadOnly

True is returned if the profile is read only. Otherwise, false is returned. Note that the read only attribute is a host software enforced restriction. The modem will simply save any information the host software sends down.

swi_bool SWI_STRUCT_GsmProfileBasic::bValid

True indicates if the basic profile info is valid, false otherwise.

swi_uint8 SWI_STRUCT_GsmProfileBasic::byPdp[LENGTH_IPAddress]

IP or PDP address when using static PDP address configuration. Example of an IPV4 address is 0x7F000201 which means 127.0.2.1.

enum SWI_TYPE_Authentication SWI_STRUCT_GsmProfileBasic::eAuthentication

Authentication type. Default should be PAP.

enum SWI_TYPE_PdpInitiated SWI_STRUCT_GsmProfileBasic::ePdpInitiated

PDP initiated type

enum SWI_TYPE_PDP SWI_STRUCT_GsmProfileBasic::ePdpType

PDP type (either IPV4, PPP, or IPV6).

swi_uint8 SWI_STRUCT_GsmProfileBasic::MccMnc[LENGTH_MCCMNC_BUFFER]

Three bytes to store MCC/MNC value

swi_uint32 SWI_STRUCT_GsmProfileBasic::nLengthPdp

Length of PDP address (0-16). 0 indicates dynamic addressing.

swi_uint32 SWI_STRUCT_GsmProfileBasic::nLingerTimer

Linger timer in minutes (1-32767). A value of 0 means disabled.

swi_uint32 SWI_STRUCT_GsmProfileBasic::nMaxPasswordLength

Indicates the maximum password string length that is supported by the device. Valid values from this field will be from 32 to 127 inclusive.

swi_uint32 SWI_STRUCT_GsmProfileBasic::nMaxUsernameLength

Indicates the maximum username string length that is supported by the device. Valid values from this field will be from 32 to 127 inclusive.

swi_uint32 SWI_STRUCT_GsmProfileBasic::nPrimaryProfileId

This field is only valid if ePdpInitiated is set to Secondary Mobile Initiated.

swi_uint8 SWI_STRUCT_GsmProfileBasic::nProfileId

Profile ID. Valid range is 1-16.

swi_uint8 SWI_STRUCT_GsmProfileBasic::nSoftwareOptions

Bitsets to store software options

• 00000001 : HSDPA profile

swi_uint8 SWI_STRUCT_GsmProfileBasic::Reserved[11]

Reserved for future use

swi_uint32 SWI_STRUCT_GsmProfileBasic::sizeStruct

The size, in bytes, of this structure.

swi_char SWI_STRUCT_GsmProfileBasic::szAccessPoint[LENGTH_AccessPointName]

A NULL terminated string representing the access point name provided by the carrier.

swi_char SWI_STRUCT_GsmProfileBasic::szLabel[LENGTH_Label]

A NULL terminated string representing a user-supplied "handle" to help them identify the account.

swi_char SWI_STRUCT_GsmProfileBasic::szPassword[LENGTH_Password]

A NULL terminated string representing the account password for carrier authentication.

swi_char SWI_STRUCT_GsmProfileBasic::szUserName[LENGTH_UserName]

A NULL terminated string representing the carrier assigned account name for carrier authentication.

---

The documentation for this struct was generated from the following file:

• SwiApiGsmNetwork.h