Detailed Description

FreeRDP: A Remote Desktop Protocol Implementation Mouse Cursor Virtual Channel Extension

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.

Field Documentation

◆ CapsAdvertise

psMouseCursorServerCapsAdvertise MouseCursorServerContext::CapsAdvertise

Callback for the CapsAdvertise PDU.

◆ CapsConfirm

psMouseCursorServerCapsConfirm MouseCursorServerContext::CapsConfirm

◆ ChannelHandle

psMouseCursorServerChannelHandle MouseCursorServerContext::ChannelHandle

Retrieve the channel handle for use in conjunction with Poll(). If externalThread=FALSE do not call.

◆ ChannelIdAssigned

psMouseCursorServerChannelIdAssigned MouseCursorServerContext::ChannelIdAssigned

Callback, when the channel got its id assigned.

◆ Close

psMouseCursorServerClose MouseCursorServerContext::Close

Close the mouse cursor channel.

◆ Initialize

psMouseCursorServerInitialize MouseCursorServerContext::Initialize

Optional: Set thread handling. When externalThread=TRUE, the application is responsible to call Poll() periodically to process channel events.

Defaults to externalThread=FALSE

◆ MouseptrUpdate

psMouseCursorServerMouseptrUpdate MouseCursorServerContext::MouseptrUpdate

◆ Open

psMouseCursorServerOpen MouseCursorServerContext::Open

Open the mouse cursor channel.

◆ Poll

psMouseCursorServerPoll MouseCursorServerContext::Poll

Poll When externalThread=TRUE, call Poll() periodically from your main loop. If externalThread=FALSE do not call.

◆ rdpcontext

rdpContext* MouseCursorServerContext::rdpcontext

◆ userdata

void* MouseCursorServerContext::userdata

◆ vcm

HANDLE MouseCursorServerContext::vcm

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

server/rdpemsc.h

Data Fields
HANDLE	vcm

void *	userdata

psMouseCursorServerInitialize	Initialize

psMouseCursorServerOpen	Open

psMouseCursorServerClose	Close

psMouseCursorServerPoll	Poll

psMouseCursorServerChannelHandle	ChannelHandle

psMouseCursorServerCapsConfirm	CapsConfirm

psMouseCursorServerMouseptrUpdate	MouseptrUpdate

psMouseCursorServerChannelIdAssigned	ChannelIdAssigned

psMouseCursorServerCapsAdvertise	CapsAdvertise

rdpContext *	rdpcontext

Data Fields