FreeRDP
client/location.h File Reference
#include <freerdp/channels/location.h>
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  LocationClientContext
 

Typedefs

typedef UINT(* pcLocationStart) (LocationClientContext *context, UINT32 version, UINT32 flags)
 
typedef UINT(* pcLocationStop) (LocationClientContext *context)
 
typedef UINT(* pcLocationSend) (LocationClientContext *context, LOCATION_PDUTYPE type, size_t count,...)
 

Detailed Description

FreeRDP: A Remote Desktop Protocol Implementation Location Virtual Channel Extension

Copyright 2024 Armin Novak anova.nosp@m.k@th.nosp@m.incas.nosp@m.t.co.nosp@m.m Copyright 2024 Thincast Technologies GmbH

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Since
version 3.4.0

Definition in file client/location.h.


Data Structure Documentation

◆ s_location_client_context

struct s_location_client_context
Since
version 3.4.0

Definition at line 48 of file client/location.h.

Data Fields
void * custom
void * handle
pcLocationSend LocationSend Send a location update.

!

This function sends location updates to a server. The following parameter formats are supported:

Parameters
typeone of the following: PDUTYPE_BASE_LOCATION3D : count = 3 | 7 latitude : double, required longitude : double, required altitude : INT32, required speed : double, optional heading : double, optional horizontalAccuracy : double, optional source : int, optional PDUTYPE_LOCATION2D_DELTA : count = 2 | 4 latitudeDelta : double, required longitudeDelta : double, required speedDelta : double, optional headingDelta : double, optional PDUTYPE_LOCATION3D_DELTA : count = 3 | 5 latitudeDelta : double, required longitudeDelta : double, required altitudeDelta : INT32, optional speedDelta : double, optional headingDelta : double, optional
countthe number of variable arguments following

return CHANNEL_RC_OK for success, an appropriate error otherwise.

pcLocationStart LocationStart initialize location services on client

!

Parameters
contextThe client context to operate on
versionThe location channel version (determines which features are available.
flagsThe location channel flags.
Returns
CHANNEL_RC_OK for success, an appropriate error otherwise.
pcLocationStop LocationStop stop location services on client

!

Parameters
contextThe client context to operate on
Returns
CHANNEL_RC_OK for success, an appropriate error otherwise.

Typedef Documentation

◆ pcLocationSend

typedef UINT(* pcLocationSend) (LocationClientContext *context, LOCATION_PDUTYPE type, size_t count,...)
Since
version 3.4.0

Definition at line 44 of file client/location.h.

◆ pcLocationStart

typedef UINT(* pcLocationStart) (LocationClientContext *context, UINT32 version, UINT32 flags)
Since
version 3.4.0

Definition at line 38 of file client/location.h.

◆ pcLocationStop

typedef UINT(* pcLocationStop) (LocationClientContext *context)
Since
version 3.4.0

Definition at line 41 of file client/location.h.