SWI_STRUCT_GsmProfileBasic Struct Reference

#include <SwiStructsGsm.h>

List of all members.

Public Attributes

U32 sizeStruct
U8 nProfileId
bool bValid
SWI_TYPE_PDP ePdpType
bool bDataCompression
bool bHeaderCompression
bool bAutomaticIP
U32 nLengthPdp
BYTE byPdp [LENGTH_IPAddress]
WCHAR szAccessPoint [LENGTH_AccessPointName]
SWI_TYPE_PdpInitiated ePdpInitiated
U32 nPrimaryProfileId
SWI_TYPE_Authentication eAuthentication
WCHAR szUserName [LENGTH_UserName]
WCHAR szPassword [LENGTH_Password]
WCHAR szLabel [LENGTH_Label]
U32 nMaxUsernameLength
U32 nMaxPasswordLength
bool bAutoActivation
bool bReadOnly
bool bPromptPassword
bool bAutoRunVPN
U32 nLingerTimer
U8 nSoftwareOptions
U8 MccMnc [LENGTH_MCCMNC_BUFFER]
U8 Reserved [11]
SWI_TYPE_ProfileAuthResult nResult


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

SWI_TYPE_ProfileAuthResult

SwiGetGsmProfileBasic

SwiSetGsmProfileBasic

SWI_NOTIFY_GsmProfileChange


Member Data Documentation

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.

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.

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

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.

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.

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

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.

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

BYTE 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.

Authentication type. Default should be PAP.

PDP initiated type

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

U8 SWI_STRUCT_GsmProfileBasic::MccMnc[LENGTH_MCCMNC_BUFFER]

Three bytes to store MCC/MNC value

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

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

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

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

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

Profile ID. Valid range is 1-16.

SWI_TYPE_ProfileAuthResult SWI_STRUCT_GsmProfileBasic::nResult

Status of request returned from modem

Bitsets to store software options

  • 00000001 : HSDPA profile

Reserved for future use

The size, in bytes, of this structure.

WCHAR SWI_STRUCT_GsmProfileBasic::szAccessPoint[LENGTH_AccessPointName]

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

A NULL terminated string representing a user-supplied "handle" to help them identify the account. The modem will accept up to 30 ASCII characters or 14 USC2 characters.

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

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


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

Generated on Fri Oct 2 10:27:33 2009 for 3G SDK by  doxygen 1.5.9