| CE Gobi SDK 2.7 GobiApi

- Main Page
- Modules
- Classes
- Files

- File List

GobiAPI.h
1 #ifndef __GOBIAPI_H__
2 /*===========================================================================
3 FILE:
4 GobiAPI.h
5
6 DESCRIPTION:
7 Sierra Wirless CE Gobi SDK Top level header file
8
9 Copyright (C) 2015 Sierra Wireless Incorporated. All rights reserved.
10 Sierra Wireless Proprietary/GTDR
11 ==========================================================================*/
12
13
14
15
16 /*=========================================================================*/
17 // ANSI/UNICODE Varaints
18 /*=========================================================================*/
19 #ifdef UNICODE
20 #define GetFirmwareID GetFirmwareIDW
21 #define UpgradeFirmware UpgradeFirmwareW
22 #define UpgradeFirmware2k UpgradeFirmware2kW
23 #define GetImageInfo GetImageInfoW
24 #define GetImageStore GetImageStoreW
25
26 #else
27 #define GetFirmwareID GetFirmwareIDA
28 #define UpgradeFirmware UpgradeFirmwareA
29 #define UpgradeFirmware2k UpgradeFirmware2kA
30 #define GetImageInfo GetImageInfoA
31 #define GetImageStore GetImageStoreA
32 #endif
33
34 #include <Windows.h>
35 #include <GobiAPIDefs.h>
36 #include <GobiErrorCodes.h>
37
42
43 // Device removal callback function
44 typedef void (GOBICALLBACK * tFNDeviceRemoval)();
45
46
56 IMPORTGOBI ULONG GOBICMAPI SetDeviceRemovalCallback(
57 tFNDeviceRemoval pCallback );
58
73 IMPORTGOBI ULONG GOBICMAPI GetImageStoreA(
74 WORD pathSize,
75 CHAR * pImageStorePath );
76
92 IMPORTGOBI ULONG GOBICMAPI GetImageInfoA(
93 CHAR * pPath,
94 ULONG * pFirmwareID,
95 ULONG * pTechnology,
96 ULONG * pCarrier,
97 ULONG * pRegion,
98 ULONG * pGPSCapability );
99
100
116 IMPORTGOBI ULONG GOBICMAPI GetImageInfoW(
117 WCHAR * pPath,
118 ULONG * pFirmwareID,
119 ULONG * pTechnology,
120 ULONG * pCarrier,
121 ULONG * pRegion,
122 ULONG * pGPSCapability );
123
124
142 IMPORTGOBI ULONG GOBICMAPI UpgradeFirmware2kA( CHAR * pDestinationPath );
143
161 IMPORTGOBI ULONG GOBICMAPI UpgradeFirmware2kW( WCHAR * pDestinationPath );
162
180 IMPORTGOBI ULONG GOBICMAPI UpgradeFirmware2kA( CHAR * pDestinationPath );
181
182
183
198 IMPORTGOBI ULONG GOBICMAPI GetImageStoreW(
199 WORD pathSize,
200 WCHAR * pImageStorePath );
201
221 IMPORTGOBI ULONG GOBICMAPI UpgradeFirmwareA(
222 CHAR * pSourcePath,
223 CHAR * pDestinationPath );
224
246 IMPORTGOBI ULONG GOBICMAPI UpgradeFirmwareW(
247 WCHAR * pSourcePath,
248 WCHAR * pDestinationPath );
249
250
251
264 IMPORTGOBI ULONG GOBICMAPI GetFirmwareIDA(
265 CHAR * pPath,
266 ULONG * pFirmwareID );
267
279 IMPORTGOBI ULONG GOBICMAPI GetFirmwareIDW(
280 WCHAR * pPath,
281 ULONG * pFirmwareID );
282
283
297 IMPORTGOBI ULONG GOBICMAPI QCWWAN2kEnumerateDevices(
298 BYTE * pDevicesSize,
299 BYTE * pDevices );
300
312 IMPORTGOBI ULONG GOBICMAPI QCWWAN2kConnect(
313 CHAR * pDeviceID,
314 CHAR * pDeviceKey );
315
326 IMPORTGOBI ULONG GOBICMAPI QCWWANConnect();
327
336 IMPORTGOBI ULONG GOBICMAPI QCWWANCancel();
337
346 IMPORTGOBI ULONG GOBICMAPI QCWWANDisconnect();
347
363 IMPORTGOBI ULONG GOBICMAPI QCWWAN2kGetConnectedDeviceID(
364 ULONG deviceIDSize,
365 CHAR * pDeviceID,
366 ULONG deviceKeySize,
367 CHAR * pDeviceKey );
368
381 IMPORTGOBI ULONG GOBICMAPI QCWWANGetConnectedDeviceID(
382 ULONG stringSize,
383 CHAR * pString );
384 // End of basic group
386
387
388
389 #include <SwiWwanCmApi.h>
390 #include <GobiConnectionMgmtAPI.h>
391 #include <QMIDMS.h>
392 #include <GobiImageMgmtAPI.h>
393 #include <GobiPBMgmtAPI.h>
394 #include <GobiUIMMgmtAPI.h>
395 #include <GobiVoiceMgmtAPI.h>
396 #include <SwiM2MAVAPI.h>
397 #include <QmiWDS.h>
398 #include <QmiNAS.h>
399 #include <SwiDMS.h>
400 #include <QmiCAT.h>
401 #include <QmiPDS.h>
402 #include <QmiWMS.h>
403 #include <QmiOMA.h>
404 #include <QmiRMS.h>
405 #include <SwiOMADMEX.h>
406 #include <PlaceHolder.h>
407
408
409
410 #endif
UpgradeFirmwareA
IMPORTGOBI ULONG GOBICMAPI UpgradeFirmwareA(CHAR *pSourcePath, CHAR *pDestinationPath)
GetImageInfoA
IMPORTGOBI ULONG GOBICMAPI GetImageInfoA(CHAR *pPath, ULONG *pFirmwareID, ULONG *pTechnology, ULONG *pCarrier, ULONG *pRegion, ULONG *pGPSCapability)
UpgradeFirmware2kW
IMPORTGOBI ULONG GOBICMAPI UpgradeFirmware2kW(WCHAR *pDestinationPath)
GetFirmwareIDA
IMPORTGOBI ULONG GOBICMAPI GetFirmwareIDA(CHAR *pPath, ULONG *pFirmwareID)
QCWWANCancel
IMPORTGOBI ULONG GOBICMAPI QCWWANCancel()
QCWWAN2kEnumerateDevices
IMPORTGOBI ULONG GOBICMAPI QCWWAN2kEnumerateDevices(BYTE *pDevicesSize, BYTE *pDevices)
GetImageStoreA
IMPORTGOBI ULONG GOBICMAPI GetImageStoreA(WORD pathSize, CHAR *pImageStorePath)
GetImageInfoW
IMPORTGOBI ULONG GOBICMAPI GetImageInfoW(WCHAR *pPath, ULONG *pFirmwareID, ULONG *pTechnology, ULONG *pCarrier, ULONG *pRegion, ULONG *pGPSCapability)
GetImageStoreW
IMPORTGOBI ULONG GOBICMAPI GetImageStoreW(WORD pathSize, WCHAR *pImageStorePath)
QCWWAN2kConnect
IMPORTGOBI ULONG GOBICMAPI QCWWAN2kConnect(CHAR *pDeviceID, CHAR *pDeviceKey)
QCWWANDisconnect
IMPORTGOBI ULONG GOBICMAPI QCWWANDisconnect()
QCWWANConnect
IMPORTGOBI ULONG GOBICMAPI QCWWANConnect()
QCWWAN2kGetConnectedDeviceID
IMPORTGOBI ULONG GOBICMAPI QCWWAN2kGetConnectedDeviceID(ULONG deviceIDSize, CHAR *pDeviceID, ULONG deviceKeySize, CHAR *pDeviceKey)
SetDeviceRemovalCallback
IMPORTGOBI ULONG GOBICMAPI SetDeviceRemovalCallback(tFNDeviceRemoval pCallback)
UpgradeFirmware2kA
IMPORTGOBI ULONG GOBICMAPI UpgradeFirmware2kA(CHAR *pDestinationPath)
GetFirmwareIDW
IMPORTGOBI ULONG GOBICMAPI GetFirmwareIDW(WCHAR *pPath, ULONG *pFirmwareID)
QCWWANGetConnectedDeviceID
IMPORTGOBI ULONG GOBICMAPI QCWWANGetConnectedDeviceID(ULONG stringSize, CHAR *pString)
UpgradeFirmwareW
IMPORTGOBI ULONG GOBICMAPI UpgradeFirmwareW(WCHAR *pSourcePath, WCHAR *pDestinationPath)