Device Management Service API function prototypes. More...
Go to the source code of this file.
Data Structures | |
struct | ERIFileparams |
struct | custFeaturesInfo |
struct | custFeaturesSetting |
struct | dmsCurrentPRLInfo |
Typedefs | |
typedef struct ERIFileparams | ERIFileparams |
typedef struct custFeaturesInfo | custFeaturesInfo |
typedef struct custFeaturesSetting | custFeaturesSetting |
typedef struct dmsCurrentPRLInfo | dmsCurrentPRLInfo |
Functions | |
ULONG | GetManufacturer (BYTE stringSize, CHAR *pString) |
ULONG | GetModelID (BYTE stringSize, CHAR *pString) |
ULONG | GetFirmwareRevision (BYTE stringSize, CHAR *pString) |
ULONG | GetFirmwareRevisions (BYTE amssSize, CHAR *pAMSSString, BYTE bootSize, CHAR *pBootString, BYTE priSize, CHAR *pPRIString) |
ULONG | GetPRLVersion (WORD *pPRLVersion) |
ULONG | GetIMSI (BYTE stringSize, CHAR *pString) |
ULONG | GetSerialNumbers (BYTE esnSize, CHAR *pESNString, BYTE imeiSize, CHAR *pIMEIString, BYTE meidSize, CHAR *pMEIDString) |
ULONG | GetHardwareRevision (BYTE stringSize, CHAR *pString) |
ULONG | GetNetworkTime (ULONGLONG *pTimeStamp, ULONG *pTimeSource) |
ULONG | UIMSetPINProtection (ULONG id, ULONG bEnable, CHAR *pValue, ULONG *pVerifyRetriesLeft, ULONG *pUnblockRetriesLeft) |
ULONG | UIMUnblockPIN (ULONG id, CHAR *pPUKValue, CHAR *pNewValue, ULONG *pVerifyRetriesLeft, ULONG *pUnblockRetriesLeft) |
ULONG | UIMVerifyPIN (ULONG id, CHAR *pValue, ULONG *pVerifyRetriesLeft, ULONG *pUnblockRetriesLeft) |
ULONG | UIMChangePIN (ULONG id, CHAR *pOldValue, CHAR *pNewValue, ULONG *pVerifyRetriesLeft, ULONG *pUnblockRetriesLeft) |
ULONG | GetVoiceNumber (BYTE voiceNumberSize, CHAR *pVoiceNumber, BYTE minSize, CHAR *pMIN) |
ULONG | SetPower (ULONG powerMode) |
ULONG | GetPower (ULONG *pPowerMode) |
ULONG | UIMGetControlKeyStatus (ULONG id, ULONG *pStatus, ULONG *pVerifyRetriesLeft, ULONG *pUnblockRetriesLeft) |
ULONG | UIMGetICCID (BYTE stringSize, CHAR *pString) |
ULONG | UIMGetPINStatus (ULONG id, ULONG *pStatus, ULONG *pVerifyRetriesLeft, ULONG *pUnblockRetriesLeft) |
ULONG | GetOfflineReason (ULONG *pReasonMask, ULONG *pbPlatform) |
ULONG | UIMSetControlKeyProtection (ULONG id, ULONG status, CHAR *pValue, ULONG *pVerifyRetriesLeft) |
ULONG | UIMUnblockControlKey (ULONG id, CHAR *pValue, ULONG *pUnblockRetriesLeft) |
ULONG | GetDeviceCapabilities (ULONG *pMaxTXChannelRate, ULONG *pMaxRXChannelRate, ULONG *pDataServiceCapability, ULONG *pSimCapability, ULONG *pRadioIfacesSize, BYTE *pRadioIfaces) |
ULONG | ResetToFactoryDefaults (CHAR *pSPC) |
ULONG | ValidateSPC (CHAR *pSPC) |
ULONG | ActivateAutomatic (CHAR *pActivationCode) |
ULONG | ActivateManual (CHAR *pSPC, WORD sid, CHAR *pMDN, CHAR *pMIN, ULONG prlSize, BYTE *pPRL, CHAR *pMNHA, CHAR *pMNAAA) |
ULONG | SLQSGetERIFile (ERIFileparams *pERIFileparams) |
ULONG | GetActivationState (ULONG *pActivationState) |
ULONG | SLQSUIMGetState (ULONG *pUIMState) |
ULONG | SLQSGetBandCapability (ULONGLONG *pBandCapability) |
ULONG | SLQSGetCustFeatures (custFeaturesInfo *pCustFeaturesInfo) |
ULONG | SLQSSetCustFeatures (custFeaturesSetting *pCustFeaturesSetting) |
ULONG | SLQSGetCurrentPRLInfo (dmsCurrentPRLInfo *pCurrentPRLInfo) |
Device Management Service API function prototypes.
Copyright: © 2011 Sierra Wireless, Inc. all rights reserved
typedef struct custFeaturesInfo custFeaturesInfo |
This structure contains current settings of custom features
GpsEnable |
| |
pDisableIMSI |
| |
pIPFamSupport |
| |
pRMAutoConnect |
| |
pGPSSel |
|
typedef struct custFeaturesSetting custFeaturesSetting |
This structure contains settings to be used for custom features
pGPSSel |
| |
pGPSEnable |
|
typedef struct dmsCurrentPRLInfo dmsCurrentPRLInfo |
This structure contains GetCurrentPRLInfo response parameter
pPRLVersion[OUT] | - Optional
| |
pPRLPreference | [OUT]- OptionaL
|
typedef struct ERIFileparams ERIFileparams |
This structure contains Extended Roaming Indicator(ERI) file parameters
pFileSize[IN/OUT] |
| |
pFile[OUT] |
|
Requests the device to perform automatic service activation
pActivationCode[IN] |
|
ULONG ActivateManual | ( | CHAR * | pSPC, | |
WORD | sid, | |||
CHAR * | pMDN, | |||
CHAR * | pMIN, | |||
ULONG | prlSize, | |||
BYTE * | pPRL, | |||
CHAR * | pMNHA, | |||
CHAR * | pMNAAA | |||
) |
Requests the device perform a manual activation using the provided parameters.
pSPC[IN] |
| |
sid[IN] |
| |
pMDN[IN] |
| |
pMIN[IN] |
| |
prlSize[IN] |
| |
pPRL[IN] |
| |
pMNHA[IN] |
| |
pMNAAA[IN] |
|
Returns the device activation state.
pActivationState[OUT] |
|
ULONG GetDeviceCapabilities | ( | ULONG * | pMaxTXChannelRate, | |
ULONG * | pMaxRXChannelRate, | |||
ULONG * | pDataServiceCapability, | |||
ULONG * | pSimCapability, | |||
ULONG * | pRadioIfacesSize, | |||
BYTE * | pRadioIfaces | |||
) |
Gets the device capabilities
pMaxTXChannelRate[OUT] |
| |
pMaxRXChannelRate[OUT] |
| |
pDataServiceCapability[OUT] |
| |
pSimCapability[OUT] |
| |
pRadioIfacesSize[IN/OUT] |
| |
pRadioIfaces[OUT] |
|
Returns the device firmware revision
stringSize |
| |
pString[OUT] |
|
ULONG GetFirmwareRevisions | ( | BYTE | amssSize, | |
CHAR * | pAMSSString, | |||
BYTE | bootSize, | |||
CHAR * | pBootString, | |||
BYTE | priSize, | |||
CHAR * | pPRIString | |||
) |
Returns the device firmmware revisions (AMSS, boot, and PRI)
amssSize |
| |
pAMSSString[OUT] |
| |
bootSize |
| |
pBootString[OUT] |
| |
priSize |
| |
pPRIString[OUT] |
|
Returns the hardware revision of the device
stringSize |
| |
pString[OUT] |
|
Returns the device IMSI
stringSize |
| |
pString[OUT] |
|
Returns the device manufacturer name
stringSize |
| |
pString[OUT] |
|
Returns the device model ID
stringSize |
| |
pString[OUT] |
|
Returns the current time of the device based on the value supported by the network.
pTimeStamp[OUT] |
| |
pTimeSource[OUT] |
|
Returns reason why the operating mode of the device is currently offline.
pReasonMask[OUT] |
| |
pbPlatform[OUT] |
|
Returns the operating mode of the device.
pPowerMode[OUT] |
|
Returns the version of the active Preferred Roaming List (PRL) in use by the device.
pPRLVersion[OUT] |
|
ULONG GetSerialNumbers | ( | BYTE | esnSize, | |
CHAR * | pESNString, | |||
BYTE | imeiSize, | |||
CHAR * | pIMEIString, | |||
BYTE | meidSize, | |||
CHAR * | pMEIDString | |||
) |
Returns all the serial numbers assigned to the device. These serial numbers include the ESN (Electronic serial number of the device), the IMEI (International Mobile Equipment Identity) and MEID (Mobile Equipment Identifier).
esnSize |
| |
pESNString[OUT] |
| |
imeiSize |
| |
pIMEIString[OUT] |
| |
meidSize |
| |
pMEIDString[OUT] |
|
Returns the voice number in use by the device
voiceNumberSize |
| |
pVoiceNumber[OUT] |
| |
minSize |
| |
pMIN |
|
Resets to default factory settings of the device
pSPC[IN] |
|
Sets the operating mode of the device.
powerMode |
|
Returns the band capability of the device.
pBandCapability[OUT] | Bitmask of bands supported by the device
|
ULONG SLQSGetCurrentPRLInfo | ( | dmsCurrentPRLInfo * | pCurrentPRLInfo | ) |
This API get the currently active PRL information of the device.
pCurrentPRLInfo |
|
ULONG SLQSGetCustFeatures | ( | custFeaturesInfo * | pCustFeaturesInfo | ) |
This API fetches the current settings of custom features
pCustFeaturesInfo |
|
ULONG SLQSGetERIFile | ( | ERIFileparams * | pERIFileparams | ) |
Returns the Extended Roaming Indicator (ERI) file that is stored in EFS on the device at a predetermined location. See the carrier requirements for specific details.
pERIFileparams |
|
ULONG SLQSSetCustFeatures | ( | custFeaturesSetting * | pCustFeaturesSetting | ) |
This API changes the settings of custom features
pCustFeaturesSetting |
|
Returns the UIM state.
pUIMState[OUT] |
|
ULONG UIMChangePIN | ( | ULONG | id, | |
CHAR * | pOldValue, | |||
CHAR * | pNewValue, | |||
ULONG * | pVerifyRetriesLeft, | |||
ULONG * | pUnblockRetriesLeft | |||
) |
Changes the PIN value for a given PIN
id |
| |
pOldValue[IN] |
| |
pNewValue[IN] |
| |
pVerifyRetriesLeft[OUT] |
| |
pUnblockRetriesLeft[OUT] |
|
ULONG UIMGetControlKeyStatus | ( | ULONG | id, | |
ULONG * | pStatus, | |||
ULONG * | pVerifyRetriesLeft, | |||
ULONG * | pUnblockRetriesLeft | |||
) |
Returns the status of the specified UIM facility control key.
id |
| |
pStatus[OUT] |
| |
pVerifyRetriesLeft[OUT] |
| |
pUnblockRetriesLeft[OUT] |
|
Returns the UIM ICCID.
stringSize |
| |
pString[OUT] |
|
ULONG UIMGetPINStatus | ( | ULONG | id, | |
ULONG * | pStatus, | |||
ULONG * | pVerifyRetriesLeft, | |||
ULONG * | pUnblockRetriesLeft | |||
) |
Gets the status of the SIM PINs
id |
| |
pStatus[OUT] |
| |
pVerifyRetriesLeft[OUT] |
| |
pUnblockRetriesLeft[OUT] |
|
ULONG UIMSetControlKeyProtection | ( | ULONG | id, | |
ULONG | status, | |||
CHAR * | pValue, | |||
ULONG * | pVerifyRetriesLeft | |||
) |
Changes the specified UIM facility control key
id |
| |
status |
| |
pValue[IN] |
| |
pVerifyRetriesLeft[OUT] |
|
ULONG UIMSetPINProtection | ( | ULONG | id, | |
ULONG | bEnable, | |||
CHAR * | pValue, | |||
ULONG * | pVerifyRetriesLeft, | |||
ULONG * | pUnblockRetriesLeft | |||
) |
Enables or disables protection of SIM contents for a given PIN
id |
| |
bEnable |
| |
pValue[IN] |
| |
pVerifyRetriesLeft[OUT] |
| |
pUnblockRetriesLeft[OUT] |
|
Unblocks the specified UIM facility control key
id |
| |
pValue[IN] |
| |
pUnblockRetriesLeft[OUT] |
|
ULONG UIMUnblockPIN | ( | ULONG | id, | |
CHAR * | pPUKValue, | |||
CHAR * | pNewValue, | |||
ULONG * | pVerifyRetriesLeft, | |||
ULONG * | pUnblockRetriesLeft | |||
) |
Unblocks a blocked SIM
id |
| |
pPUKValue[IN] |
| |
pNewValue[IN] |
| |
pVerifyRetriesLeft[OUT] |
| |
pUnblockRetriesLeft[OUT] |
|
ULONG UIMVerifyPIN | ( | ULONG | id, | |
CHAR * | pValue, | |||
ULONG * | pVerifyRetriesLeft, | |||
ULONG * | pUnblockRetriesLeft | |||
) |
Verifies a SIM PIN.
id |
| |
pValue[IN] |
| |
pVerifyRetriesLeft[OUT] |
| |
pUnblockRetriesLeft[OUT] |
|
This function Validates Service Programming code of the device
pSPC[IN] |
|