Intermec CK71 WWAN Toolkit Programmer's Reference Manual

Intermec CK71 Manual

Intermec CK71 manual content summary:

  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 1
    WWAN Toolkit Programmer's Reference Manual
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 2
    www.intermec.com The information contained herein is provided solely for the purpose of allowing customers to operate and service Intermec- part of Intermec Technologies Corporation. © 2006-2011 by Intermec Technologies Corporation. All rights reserved. The word Intermec, the Intermec logo
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 3
    Number 003 002 001 Date 11/2011 9/2009 8/2008 Description of Change This document was updated to: • Remove information for the Connectivity API, which is no longer supported of the manual. The part number was also changed to a standard Intermec part number. WWAN Toolkit Programmer's Reference
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 4
    iv WWAN Toolkit Programmer's Reference Manual
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 5
    Before You Begin ix Safety Information ix Global Services and Support ix Warranty Information ix Web Support ix Send Feedback ix Telephone Support ix Who Should Read This Manual x Related Documents x About the Toolkit API 13 Power Management Functions 13 Turn Power On to the Built
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 6
    PC 38 Add a RAS Entry to the PocketPC Connection Manager 38 Remove a RAS Entry From the PocketPC Connection Manager 39 Get Destination Information From PocketPC Connection Manager 39 Set the Default Dial RAS Entry for PocketPC Connection Manager 39 Set Up a GPRS Context 40 Get the GPRS PDP
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 7
    Version on the Radio 52 Get the Phone Number 52 Determine the 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
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 8
    viii WWAN Toolkit Programmer's Reference Manual
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 9
    special instructions for handling a particular condition or set of circumstances. 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
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 10
    . Before you work with the WWAN Toolkit, you should be familiar with your network and general networking terms, such as IP address. Related Documents This is a list of related Intermec documents. • WWAN Toolkit User's Guide • CN3 Mobile Computer for Windows Mobile 5.0 User's Manual • CN3 Mobile
  • Intermec CK71 | 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 CK71 | WWAN Toolkit Programmer's Reference Manual - Page 12
    Before You Begin xii WWAN Toolkit Programmer's Reference Manual
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 13
    set with a length of 256 characters. • All methods are synchronous, which means that they do not return until the operation is completed unless otherwise stated. For additional development guidelines, please refer to the WWAN Toolkit User's Guide. Power Management wireless wireless wireless setting setup
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 14
    and modem setup functions. Setup WWAN Toolkit Event Reporting Description: Method: Return Value: This function sets up the callback mechanisms to report the various modem events notifications, set = NULL to disable event reporting. Unsigned integer containing the Windows message number, set =
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 15
    Connection Manager lParam Modem Support 0-5 Supported on all 0/1 0/1 0/1 Not CDMA 0/1 Not CDMA SMS location Not CDMA 0/1 Supported on all 0 = Unknown Supported user name/password/domain. The remote access server has requested a callback number. This occurs only if the user has "Set
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 16
    device is attempting to connect. CONNMGR_STATUS_WAITINGCONNECTIONABORT The device is aborting the connection attempt. CONNMGR_STATUS_WAITINGDISCONNECTION The connection is being brought down. For more information, see the WWAN Toolkit User's Guide. 16 WWAN Toolkit Programmer's Reference Manual
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 17
    The port information cannot be set. The specified port is not connected. An invalid event was connection was closed. The connection was closed by the remote computer. The modem (or other connecting device) was disconnected due to hardware failure. The user disconnected the modem (or other connecting
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 18
    support the client. One of your computer's NetBIOS names is already registered on the remote password for this account has expired. The account does not have permission to dial in. The remote access server is not responding. The modem (or other connecting was an attempt to set a macro not listed in
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 19
    connecting connection default-off. ERROR_EMPTY_INI_FILE The 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 (or other connecting connecting
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 20
    Description The modem moved to a connection speed not supported by the COM driver. Device response received when none expected. The connection needs information from you, but the application does not allow user interaction. The callback number is invalid. The authorization state is
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 21
    encryption type. The remote computer does not support the required data encryption type. The remote computer requires data encryption. The system cannot use the IPX network number assigned by the remote computer. Additional information is provided in the event log. The Session Management Module (SMM
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 22
    management for cross device support. PIN_CODES CheckSimPin() locked and requires a PIN code to be entered. SIM card is locked and requires a PUK code to be entered. IM card is locked and requires a PUK2 code to be entered. Enter the PIN for a SIM Card Description: This function sends the PIN Number
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 23
    FALSE means that the PIN code is switched off. Enter the PUK for a SIM Card Description: The PUK number is the 'Phone Unlock Key' that is required when the PIN number has been entered incorrectly 3 times. This function sends the PUK Number to the modem. The function should only be used after
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 24
    This function asks the modem to return the current signal strength. This value is then converted to a number of bars as displayed on a mobile phone. BOOL SignalStrength( int *Strength ) The function returns a by a mobile phone: 0 to 5 for all devices. 24 WWAN Toolkit Programmer's Reference Manual
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 25
    returns TRUE if your GSM wireless radio is attached to a GPRS network. If the GSM wireless radio is not attached to Set FALSE to detach from the GPRS network. Network Selection Functionality This section describes the network selection functions. Note: The functions below are not supported Manual 25
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 26
    returns with a FALSE. Parameter Descriptions Parameter ConnectionStatus NetworkName NetworkID Description A number indicating if a connection to the network is possible. This can be one of the following BOOL RegisterWithOperator( LPCTSTR OperatorId ) 26 WWAN Toolkit Programmer's Reference Manual
  • Intermec CK71 | 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 CK71 | WWAN Toolkit Programmer's Reference Manual - Page 28
    This section describes all SMS related functions. Set the SMS Service Center Number on the 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: BOOL
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 29
    number or an international format number. Date and time the message was sent in the format year/month/ day, hour:minute:second, millisecond, such 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
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 30
    slots are available in the phone book. Note: This function is not supported on devices with a data-only radio. Method: Return Value: BOOL Parameter Descriptions Parameter PhoneNumber Name Description String containing the telephone number to store. It is good practice to prefix it with
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 31
    to an upper limit, which varies by device. String containing the telephone number to call. It is good practice to prefix it with a plus sign book file created by the toolkit. Note: This function is not supported on devices with a data-only radio. Method: Return Value: BOOL Reference Manual 31
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 32
    . Note: This function is not supported on devices with a data-only radio. Method: Return Value: BOOL HangUpPhoneCall( BOOL Data ) The function returns a Boolean TRUE if successful or a Boolean FALSE if not. Parameter Descriptions Parameter Data Description Set TRUE if ending a data or fax call
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 33
    To setup DTMF in supported numbers sets the duration of all subsequent DTMF tones sent to the recipient of a voice call. It is only required to call this method once, unless it is required to change the duration. The DTMF tone is sent using the DTMFToneSend method. Note: This function is not supported
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 34
    Parameter Level Description Returns an integer between 0 (quiet) and 19 (loud). Set the Microphone Volume Description: This function sets the current audio gain level (volume) of the microphone. Note: This function is not supported on devices with a data-only radio. Note: This function is not
  • Intermec CK71 | 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 CK71 | WWAN Toolkit Programmer's Reference Manual - Page 36
    function sets the current audio gain level (volume) of the speaker. Note: This function is not supported on 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 CK71 | WWAN Toolkit Programmer's Reference Manual - Page 37
    ,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's Reference Manual 37
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 38
    Manager, such as My ISP. String containing the name of an entry in the connection manager, such as My GPRS Connection. 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 CK71 | WWAN Toolkit Programmer's Reference Manual - Page 39
    destination specified, the string is empty. Pass a NULL if this information is not required. Set the Default Dial RAS Entry for PocketPC Connection Manager Description: Method: Return Value: This function sets the 'always dial' flag for a specified entry in a specified destination in the PocketPC
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 40
    flag set. Set Up a GPRS Context Description: This function sets up a GPRS context. This is not supported on CDMA networks. Data/header compression is not supported on of the GPRS context (set of connection data) to be used. This is normally 1 but a GPRS radio can be set up with 3 different
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 41
    information, if it is set up with the SetModemEventReporting function. If you are using PocketPC 2002 or 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 CK71 | WWAN Toolkit Programmer's Reference Manual - Page 42
    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 use the Connection Manager functionality, like DoDialUpConnect() and DoDialUpHangup(). 42 WWAN Toolkit Programmer's Reference Manual
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 43
    makes a 1xRTT, GPRS, or dialup connection without using connection manager. This also pings the specified IP address to ensure that the connection is still open. Once the function has been called, the toolkit receives RAS callback information, if it is set up with the SetModemEventReporting function
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 44
    supported on devices running Windows Mobile 5.0. Applications running on newer devices should use the Connection Manager a single ping to a user-specified IP address to determine if the Wireless Wide Area Network is available To prevent interference with the USB connection, remove the device from the
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 45
    function creates a new dialing location in the connection settings. Method: BOOL CreateDiallingLocation( LPCTSTR lpszLocation, 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 CK71 | WWAN Toolkit Programmer's Reference Manual - Page 46
    Connection Manager is not on the device. CONNECTS_TO_INTERNET: The network card is connecting to the 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 CK71 | WWAN Toolkit Programmer's Reference Manual - Page 47
    of the following: CONNECTS_TO_INTERNET: The network card is connecting to the internet settings defined in connection manager. CONNECTS_TO_WORK: The network card is connecting to the work settings defined in connection manager. Get Connection Statistics Description: Method: This function obtains
  • Intermec CK71 | 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 has not been set up properly. WWANERRORCODE_DLL_NOT_INITIALIZED On occurrence, please report to your Intermec representative. 48 WWAN Toolkit Programmer's Reference Manual
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 49
    only occur at the moment when the radio is turned on and when the toolkit is set up: • If these errors occur constantly, there might be something wrong with your wireless WAN device. • If any of these events happen once, try warm-booting the device. WWAN Toolkit Programmer's Reference Manual 49
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 50
    basis, report it to your Intermec representative or Knowledge Central. Note: To aid Intermec support staff, you should run the devices operating on a CDMA network, this function retrieves the phone number associated with the radio. BOOL GetSubscriberID( LPTSTR SubscriberID ) Return Value Manual
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 51
    0 RADIOTYPE_GSM 1 RADIOTYPE_UNKNOWN 2 Obtain the Serial Number of the Radio Description: This function retrieves the unique identifier for the wireless WAN radio present in the device. For devices identifier held by the radio, for example SIEMENS. WWAN Toolkit Programmer's Reference Manual 51
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 52
    . Parameter Descriptions Parameter RevisionIdent Description String containing the firmware revision number of the radio, such as 1.03.01. Get the Phone Number Description: Method: Return Value: This function retrieves the device phone number. For devices operating on GSM networks, the phone
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 53
    0. WWANTK_RADIOCAPS_SUPPORTSDATA: Indicates that the radio hardware supports data connection functionality. Currently, all of the radios supported by the WWAN Toolkit include this feature. the size of the string buffer (in characters). WWAN Toolkit Programmer's Reference Manual 53
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 54
    Set the Current Carrier 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
  • Intermec CK71 | WWAN Toolkit Programmer's Reference Manual - Page 55
    is only supported on devices that for the Wireless WAN Toolkit dll number of the onboard toolkit dll. • revision: Integer showing the revision build number of the onboard toolkit dll. • build: Integer showing the build number of the onboard toolkit dll. WWAN Toolkit Programmer's Reference Manual
  • Intermec CK71 | 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
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56

WWAN Toolkit
Programmer’s Reference Manual