Contains source code for GSM APIs related to the Location Based Services. More...

#include "SwiApiCmLbs.h"
#include "SwiApiGsmLbs.h"
#include "ap/apidefs.h"
#include "sl/sludefs.h"

Functions
package SWI_API SWI_RCODE	SwiSetLbsPaKeepWarmStart (swi_uint32 timeout)

package SWI_API SWI_RCODE	SwiGetLbsPaWarmStatus (struct SWI_STRUCT_LbsPaWarmStatus *psLbsPaWarmStatus, swi_uint32 timeout)

package SWI_API SWI_RCODE	SwiSetLbsPaKeepWarmStop (swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetLbsFixSettings (struct SWI_STRUCT_LbsFixSettings *psLbsFixSettings, swi_uint32 timeout)

package SWI_API SWI_RCODE	SwiSetLbsFixSettings (struct SWI_STRUCT_LbsFixSettings *psLbsFixSettings, swi_uint32 timeout)

package SWI_API SWI_RCODE	SwiSetLbsNiReq (struct SWI_STRUCT_LbsNiReq *pLbsNiReq, swi_uint32 timeout)

Detailed Description

Contains source code for GSM APIs related to the Location Based Services.

Function Documentation

SWI_API SWI_RCODE SwiGetLbsFixSettings	(	struct SWI_STRUCT_LbsFixSettings *	psLbsFixSettings,
		swi_uint32	timeout
	)

Use this function to retrieve location fix settings stored on the device.

Parameters

psLbsSettings,:	[OUT] A pointer to a SWI_STRUCT_LbsFixSettings structure which contains location fix settings.
timeout,:	[IN] Function timeout in milliseconds.

Returns: SWI_RCODE_OK indicates that the modem has received the request.; See SWI_STRUCT_LbsFixSettings for actual results of the transaction.; See SWI_RCODE for additional information.

package SWI_API SWI_RCODE SwiGetLbsPaWarmStatus	(	struct SWI_STRUCT_LbsPaWarmStatus *	psLbsPaWarmStatus,
		swi_uint32	timeout
	)

Use this function to get the Keep Warm processing status.

Parameters

psLbsPaWarmStatus,:	[OUT] A pointer to a SWI_STRUCT_LbsPaWarmStatus structure which contains warm status information.
timeout,:	[IN] Function timeout in milliseconds.

package SWI_API SWI_RCODE SwiSetLbsFixSettings	(	struct SWI_STRUCT_LbsFixSettings *	psLbsFixSettings,
		swi_uint32	timeout
	)

Use this function to change location fix settings stored on the device.

Parameters

psLbsSettings,:	[IN] A pointer to a SWI_STRUCT_LbsFixSettings structure which contains location fix settings.
timeout,:	[IN] Function timeout in milliseconds.

Returns: SWI_RCODE_OK indicates that the modem has received the request.; See SWI_STRUCT_LbsFixSettings for actual results of the transaction.; See SWI_RCODE for additional information.

package SWI_API SWI_RCODE SwiSetLbsNiReq	(	struct SWI_STRUCT_LbsNiReq *	pLbsNiReq,
		swi_uint32	timeout
	)

Use this function to respond to a network initiated location fix request.

The host is notified of a network initiated location fix request via SWI_NOTIFY_LbsNiReq.

Parameters

pLbsNiReq,:	[IN/OUT] A pointer to a SWI_STRUCT_LbsNiReq structure which contains network initiated request information.
timeout,:	[IN] Function timeout in milliseconds.

Returns: SWI_RCODE_OK indicates that the modem has received the request.; See SWI_STRUCT_LbsNiReq::eErrCode for actual results of the transaction.; See SWI_RCODE for additional information.

package SWI_API SWI_RCODE SwiSetLbsPaKeepWarmStart ( swi_uint32 timeout )

Use this function to start Keep Warm processing.

This downloads GPS assistance data over the network. The status of the process can be monitored using:

Parameters

timeout,: [IN] Function timeout in milliseconds.

package SWI_API SWI_RCODE SwiSetLbsPaKeepWarmStop ( swi_uint32 timeout )

Use this function to stop the Keep Warm processing.

SWI_NOTIFY_LbsPaWarmDone is generated when the process completes.

Parameters

timeout,: [IN] Function timeout in milliseconds.

Returns: SWI_RCODE_OK indicates that the modem has successfully received the stop request. A SWI_NOTIFY_LbsPaWarmDone notification is sent the the actually process terminates.; See SWI_RCODE for additional information.