Intermec CK70 WWAN Toolkit Programmer's Reference Manual
Intermec CK70 Manual
View all Intermec CK70 manuals
Add to My Manuals
Save this manual to your list of manuals |
Intermec CK70 manual content summary:
- Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 1
WWAN Toolkit Programmer's Reference Manual - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 2
service Intermec-manufactured equipment and is not to be released, reproduced, or used for any other purpose without written permission of Intermec Technologies Corporation. Information and specifications either trademarks or registered trademarks of Intermec Technologies Corporation. There are U.S. - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 3
to: • Remove information for the Connectivity API, which is no longer supported. • Remove information for the 700 Series Mobile Computers. • Include information to this version of the manual. The part number was also changed to a standard Intermec part number. WWAN Toolkit Programmer's Reference - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 4
iv WWAN Toolkit Programmer's Reference Manual - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 5
Services and Support ix Warranty Information ix Web Support ix Send Feedback ix Telephone Support ix Who Should Read This Manual If the Modem Is Ready for Use 14 Enable Modem Event Reporting 14 SIM Card Management 22 Available Network 26 Register With a Specific Network 26 Build a List - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 6
Handling Methods 47 Clear WWAN Error Code 47 Get Last WWAN Error Code 48 Get Last WWAN Error String 48 vi WWAN Toolkit Programmer's Reference Manual - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 7
Radio Capabilities 53 Carrier Selection Functions 53 Get the Current Carrier Selection 53 Set the Current Carrier Selection 54 Get the Supported Carriers 54 Get the Next Supported Carrier From the Carrier List 55 Versioning 55 Get WWAN Toolkit Version 55 WWAN Toolkit Programmer's Reference - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 8
viii WWAN Toolkit Programmer's Reference Manual - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 9
Global Services and Support Warranty Information To understand the warranty for your Intermec product, visit the Intermec website at www.intermec.com and click Support > Returns and Repairs > Warranty. Web Support Visit the Intermec website at www.intermec.com to download our current manuals (in PDF - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 10
list of related Intermec documents. • WWAN Toolkit User's Guide • CN3 Mobile Computer for Windows Mobile 5.0 User's Manual • CN3 Mobile Computer for Windows Mobile 6.1 User's Manual • CN4 Mobile Computer User's Manual • CN50 Mobile Computer for Windows Mobile 6.1 User's Manual • CN50 Mobile Computer - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 11
Before You Begin If your product does not have its own product page, click Support > Manuals. Use the Product Category, the Product Family, and Product to help find your documentation. WWAN Toolkit Programmer's Reference Manual xi - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 12
Before You Begin xii WWAN Toolkit Programmer's Reference Manual - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 13
are grouped by their relation to one another. For additional development guidelines, see the WWAN Toolkit User's Guide. Before using the functions in the API, note that: • All LPTSTR definitions must be set successful or a Boolean FALSE if not. WWAN Toolkit Programmer's Reference Manual 13 - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 14
The function returns TRUE even if the SIM card requires a PIN code to unlock it. Enable Modem Event Reporting Description: Method: Return Value: This function sets up the callback mechanisms to reporting. Valid values are "WM_USER" through "0x7FFF". 14 WWAN Toolkit Programmer's Reference Manual - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 15
is immediately followed by one of the more specific authentication states following. If dwError is nonzero, authentication has failed, and the error value indicates why. The client has requested another validation attempt with a new user name/password/domain. The remote access server has requested - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 16
preparation for callback. The client is delaying in order to give the modem time to reset itself in preparation for callback. The client is waiting for an incoming call from the brought down. For more information, see the WWAN Toolkit User's Guide. 16 WWAN Toolkit Programmer's Reference Manual - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 17
the remote computer. The modem (or other connecting device) was disconnected due to hardware failure. The user disconnected the modem (or other connecting device). An incorrect structure size was detected. The modem ( the port is not the one expected. WWAN Toolkit Programmer's Reference Manual 17 - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 18
occurred involving NetBIOS. The server cannot allocate NetBIOS resources needed to support the client. One of your computer's NetBIOS names is already to log on at this time of day. The account is disabled. The password for this account has expired. The account does not have permission to dial Manual - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 19
media .INI file is empty. ERROR_AUTHENTICATION_FAILURE Access was denied because the username and/or password was invalid on the domain. ERROR_PORT_OR_DEVICE There was a hardware failure in the modem ( command in the device.INF file is too long. WWAN Toolkit Programmer's Reference Manual 19 - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 20
supported by the COM driver. Device response received when none expected. The connection needs information from you, but the application does not allow user previously used password. Serial overrun errors were detected while communicating with the modem. The Remote Access Service Manager could Manual - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 21
password. Redial, entering the password explicitly. An invalid dialing rule was detected. The local computer does not support the required data encryption type. The remote computer does not support the port has been disconnected due to inactivity. WWAN Toolkit Programmer's Reference Manual 21 - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 22
the CheckSimPin() function again to ensure the status of the SIM card. Note: This function is not supported on CDMA networks. Method: Return Value: BOOL EnterSimPin( LPCTSTR PinNumber ) The fuction returns a Boolean the four digit PIN code. 22 WWAN Toolkit Programmer's Reference Manual - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 23
method requires that the "Lock" function is enabled (Call TurnSimPinOnOff() with parameter On = TRUE). Note: This function is not supported on CDMA networks. Method: Return Value: the SIM card. Note: This function is not supported on CDMA networks. WWAN Toolkit Programmer's Reference Manual 23 - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 24
Description Integer containing the signal strength in a range corresponding to the bars displayed by a mobile phone: 0 to 5 for all devices. 24 WWAN Toolkit Programmer's Reference Manual - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 25
Functionality This section describes the network selection functions. Note: The functions below are not supported on CDMA devices. Automatic Network Registration Description: It is possible to let the TRUE if successful or a Boolean FALSE if not. WWAN Toolkit Programmer's Reference Manual 25 - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 26
containing the ID of the available network, such as 240 08 or 234 10. Register With a Specific Network Description: Method: If you wish to register with an available network, use this function. It BOOL RegisterWithOperator( LPCTSTR OperatorId ) 26 WWAN Toolkit Programmer's Reference Manual - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 27
the internal list just before this function is called for the first time. This is not supported on CDMA devices. BOOL GetNextKnownNetworkOperator( LPTSTR NetworkName, LPTSTR NetworkId ) The function returns a Boolean network, such as 240 08 or 234 10. WWAN Toolkit Programmer's Reference Manual 27 - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 28
SIM Card Description: This function sets the SMS service center number, which is commonly predefined on the SIM card. Note: The functions below are not supported on CDMA networks. Method: Return Value: phone number or an international format number. 28 WWAN Toolkit Programmer's Reference Manual - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 29
as 02/07/19,08:49:10,04. String containing the text of the message. A maximum of 160 characters are allowed. WWAN Toolkit Programmer's Reference Manual 29 - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 30
an error when no more slots are available in the phone book. Note: This function is not supported on devices with a data-only radio. Method: Return Value: BOOL WritePhoneBookEntry( LPCTSTR PhoneNumber, LPCTSTR with the telephone number being stored. 30 WWAN Toolkit Programmer's Reference Manual - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 31
is deleted from the special phone book file created by the toolkit. Note: This function is not supported on devices with a data-only radio. Method: Return Value: BOOL DeletePhoneBookEntry( int Location ) The an upper limit, which varies by device. WWAN Toolkit Programmer's Reference Manual 31 - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 32
the incoming call shows the type of call i.e. voice, data or fax. Note: This function is not supported on devices with a data-only radio. Method: BOOL AnswerPhoneCall() Return Value: The function returns a Boolean country code, such as +441189876543. 32 WWAN Toolkit Programmer's Reference Manual - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 33
recipient of voice call (tones which correspond to specific button presses). Only call this method when in DTMFToneDuration method. Note: This function is not supported on devices with a data-only radio. Method supported on devices with a data-only radio. Note: This function is not supported on - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 34
on devices with a data-only radio. Note: This function is not supported on the CN4, CN50, or CS40. Method: BOOL SetMicVol( int Level ) Parameter Descriptions Parameter Level Description Returns an integer between 0 (quiet) and 19 (loud). 34 WWAN Toolkit Programmer's Reference Manual - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 35
function retrieves the current audio gain level (volume) of the speaker. Note: This function is not supported on devices with a data-only radio. Method: Return Value: BOOL GetSpeakerVol( int *Level ) The an integer between 0 (quiet) and 26 (loud). WWAN Toolkit Programmer's Reference Manual 35 - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 36
volume) of the speaker. Note: This function is not supported on devices with a data-only radio. Method: Return speaker by 1. Note: This function is not supported on devices with a data-only radio. Method: speaker by 1. Note: This function is not supported on devices with a data-only radio. Method - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 37
), such as +CGDCONT=1,IP,my.apn.name. Additional dial string commands are not supported by all radios. String containing the username for the connection (NULL if not required). String containing the password for the username defined for the connection (NULL if not required). WWAN Toolkit Programmer - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 38
. Boolean value defining the state of the always dial flag in the selected connection manager destination. Default value is TRUE. 38 WWAN Toolkit Programmer's Reference Manual - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 39
. Parameter Descriptions Parameter lpszDestination Description String specifying the name of an existing destination in the Connection Manager, such as My ISP. WWAN Toolkit Programmer's Reference Manual 39 - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 40
sets up a GPRS context. This is not supported on CDMA networks. Data/header compression is not supported on Siemens MC45 or MC46. Method: BOOL Protocol address from the GPRS network if used. This is not supported on CDMA networks. BOOL GetGPRSPDPAddress( int ContextNumber, LPTSTR PDPAddress ) - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 41
2003, this uses Connection Manager. Note: This is an asynchronous function. Monitor Connection Manager events to stay updated on status changes. WWAN Toolkit Programmer's Reference Manual 41 - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 42
charges. Note: Starting with Windows Mobile 6.0, Microsoft no longer supports the creation of data connections using the RAS API. As a result, this function is only supported on devices running Windows Mobile 5.0. Applications running on newer devices should - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 43
with Windows Mobile 6.0, Microsoft no longer supports the creation of data connections using the RAS API. As a result, this function is only supported on devices running Windows Mobile 5.0. Applications empty string to disable the ping functionality. WWAN Toolkit Programmer's Reference Manual 43 - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 44
no longer supports the creation of data connections using the RAS API. As a result, this function is only supported on devices WWAN Network Status Description: This function sends a single ping to a user-specified IP address to determine if the Wireless Wide Area Network is 's Reference Manual - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 45
containing the dialing format for international calls. Set TRUE to ensure that we overwrite any existing location details set to TRUE. WWAN Toolkit Programmer's Reference Manual 45 - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 46
internet settings defined in connection manager. CONNECTS_TO_WORK: The network card is connecting to the work settings defined in connection manager. 46 WWAN Toolkit Programmer's Reference Manual - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 47
The number of timeout errors. Error Handling Methods This section describes the error handling methods of the API. Clear WWAN Error Code Description: This function resets the errorcode to 0 (WWANERRORCODE_NO_ERROR). Method: VOID ClearWWANErrorCode() WWAN Toolkit Programmer's Reference - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 48
The handheld device and/or wireless WAN radio is not supported by the toolkit. WWANERRORCODE_BAD_RADIO_IMPLEMENTATION Error detected in lower level properly. WWANERRORCODE_DLL_NOT_INITIALIZED On occurrence, please report to your Intermec representative. 48 WWAN Toolkit Programmer's Reference Manual - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 49
be loaded. Make sure your operating system is supported by this version of the toolkit. The following OS's are currently supported: • Windows Mobile 5.0 • Windows Mobile 6.1 WAN device. • If any of these events happen once, try warm-booting the device. WWAN Toolkit Programmer's Reference Manual 49 - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 50
these errors occur on a regular basis, report it to your Intermec representative or Knowledge Central. Note: To aid Intermec support staff, you should run the Device Info tool and include the RADIOMODEL_SIERRA_MC5728 9 RADIOMODEL_SIERRA_MC8795 10 50 WWAN Toolkit Programmer's Reference Manual - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 51
a Boolean FALSE if not. Parameter Descriptions Parameter Manufacturer Description String containing the manufacturer identifier held by the radio, for example SIEMENS. WWAN Toolkit Programmer's Reference Manual 51 - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 52
TRUE if a phone number was found or a Boolean FALSE if not. Parameter Descriptions Parameter PhoneNumber Description The unit's phone number. 52 WWAN Toolkit Programmer's Reference Manual - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 53
selected network carrier, such as "Sprint" or "Generic UMTS". Note: This function is only supported on devices that have a Flexible Network Radio, such as the Sierra MC8355. Method: Return Value containig the size of the string buffer (in characters). WWAN Toolkit Programmer's Reference Manual 53 - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 54
Selection Description: This function instructs the radio to switch to the specified network carrier, such as "Sprint" or "Generic UMTS". The GetSupportedCarriers() and GetNextSupportedCarrier() functions determine which carriers are available. This function resets the radio to change carriers - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 55
it indicates there are no more entries (by returning FALSE). Note: This function is only supported on devices that have a Flexible Network Radio, such as the Sierra MC8355. Method: Return Integer showing the build number of the onboard toolkit dll. WWAN Toolkit Programmer's Reference Manual 55 - Intermec CK70 | WWAN Toolkit Programmer's Reference Manual - Page 56
Worldwide Headquarters 6001 36th Avenue West Everett, Washington 98203 U.S.A. tel 425.348.2600 fax 425.355.9551 www.intermec.com © 2011 Intermec Technologies Corporation. All rights reserved. WWAN Toolkit Programmer's Reference Manual *937-013-003* P/N 937-013-003
WWAN Toolkit
Programmer’s Reference Manual