le_posCtrl_interface.h File Reference

#include "legato.h"

Go to the source code of this file.

Typedefs
typedef struct le_posCtrl_Activation *	le_posCtrl_ActivationRef_t

Functions
void	le_posCtrl_ConnectService (void)
void	le_posCtrl_DisconnectService (void)
le_posCtrl_ActivationRef_t	le_posCtrl_Request (void)
void	le_posCtrl_Release (le_posCtrl_ActivationRef_t ref)

Detailed Description

Legato Positioning Control API include file.

Copyright (C) Sierra Wireless Inc. Use of this work is subject to license.

Typedef Documentation

typedef struct le_posCtrl_Activation* le_posCtrl_ActivationRef_t

Reference type for dealing with Position Service management.

Function Documentation

void le_posCtrl_ConnectService

(

void

)

Connect the current client thread to the service providing this API.

This function must be called before any other functions in this API. Normally, it's automatically called for the main thread, but must be explicitly called for other threads. For details, see Client-specific Functions.

This function is created automatically.

void le_posCtrl_DisconnectService

(

void

)

Disconnect the current client thread from the service providing this API.

Normally, this function doesn't need to be called. After this function is called, there's no longer a connection to the service, and the functions in this API can't be used. For details, see Client-specific Functions.

This function is created automatically.

void le_posCtrl_Release

(

le_posCtrl_ActivationRef_t

ref

)

Release the positioning service.

Parameters

[in]

ref

Reference to a positioning service activation request.

le_posCtrl_ActivationRef_t le_posCtrl_Request

(

void

)

Request activation of the positioning service.

Returns

• Reference to the service activation request (to be used later for releasing the request).
• NULL if the service request could not be processed.