FreeRDP
Data Fields
LocationClientContext Struct Reference

Data Fields

void * handle
 
void * custom
 
pcLocationStart LocationStart
 initialize location services on client More...
 
pcLocationStop LocationStop
 stop location services on client More...
 
pcLocationSend LocationSend
 Send a location update. More...
 

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.

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

Field Documentation

◆ custom

void* LocationClientContext::custom

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

◆ handle

void* LocationClientContext::handle

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

◆ LocationSend

pcLocationSend LocationClientContext::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.

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

◆ LocationStart

pcLocationStart LocationClientContext::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.

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

◆ LocationStop

pcLocationStop LocationClientContext::LocationStop

stop location services on client

!

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

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

The documentation for this struct was generated from the following file: