wtsvc.h File Reference

#include <freerdp/types.h>
#include <freerdp/peer.h>
#include <winpr/winpr.h>
#include <winpr/wtypes.h>
#include <winpr/wtsapi.h>

This graph shows which files directly or indirectly include this file:

Typedefs
typedef BOOL(*	psDVCCreationStatusCallback) (void *userdata, UINT32 channelId, INT32 creationStatus)

Enumerations
enum	{ DRDYNVC_STATE_NONE = 0 , DRDYNVC_STATE_INITIALIZED = 1 , DRDYNVC_STATE_READY = 2 , DRDYNVC_STATE_FAILED = 3 }

Functions
FREERDP_API BOOL	WTSVirtualChannelManagerOpen (HANDLE hServer)
FREERDP_API BOOL	WTSVirtualChannelManagerCheckFileDescriptor (HANDLE hServer)
FREERDP_API BOOL	WTSVirtualChannelManagerCheckFileDescriptorEx (HANDLE hServer, BOOL autoOpen)
FREERDP_API HANDLE	WTSVirtualChannelManagerGetEventHandle (HANDLE hServer)
FREERDP_API BOOL	WTSVirtualChannelManagerIsChannelJoined (HANDLE hServer, const char *name)
FREERDP_API BYTE	WTSVirtualChannelManagerGetDrdynvcState (HANDLE hServer)
FREERDP_API void	WTSVirtualChannelManagerSetDVCCreationCallback (HANDLE hServer, psDVCCreationStatusCallback cb, void *userdata)
FREERDP_API UINT16	WTSChannelGetId (freerdp_peer *client, const char *channel_name)
FREERDP_API BOOL	WTSIsChannelJoinedByName (freerdp_peer *client, const char *channel_name)
FREERDP_API BOOL	WTSIsChannelJoinedById (freerdp_peer *client, const UINT16 channel_id)
FREERDP_API BOOL	WTSChannelSetHandleByName (freerdp_peer *client, const char *channel_name, void *handle)
FREERDP_API BOOL	WTSChannelSetHandleById (freerdp_peer *client, const UINT16 channel_id, void *handle)
FREERDP_API void *	WTSChannelGetHandleByName (freerdp_peer *client, const char *channel_name)
FREERDP_API void *	WTSChannelGetHandleById (freerdp_peer *client, const UINT16 channel_id)
FREERDP_API const char *	WTSChannelGetName (freerdp_peer *client, UINT16 channel_id)
FREERDP_API char **	WTSGetAcceptedChannelNames (freerdp_peer *client, size_t *count)
FREERDP_API INT64	WTSChannelGetOptions (freerdp_peer *client, UINT16 channel_id)
FREERDP_API UINT32	WTSChannelGetIdByHandle (HANDLE hChannelHandle)

Typedef Documentation

psDVCCreationStatusCallback

typedef BOOL(* psDVCCreationStatusCallback) (void *userdata, UINT32 channelId, INT32 creationStatus)

Enumeration Type Documentation

anonymous enum

anonymous enum

FreeRDP: A Remote Desktop Protocol Implementation Server Virtual Channel Interface

Copyright 2011-2012 Vic Lee

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. The server-side virtual channel API follows the Microsoft Remote Desktop Services API functions WTSVirtualChannel* defined in: http://msdn.microsoft.com/en-us/library/windows/desktop/aa383464.aspx

Difference between the MS API are documented in this header. All functions are implemented in and integrated with libfreerdp-channels.

Unlike MS API, all functions except WTSVirtualChannelOpenEx in this implementation are thread-safe.

Enumerator
DRDYNVC_STATE_NONE
DRDYNVC_STATE_INITIALIZED
DRDYNVC_STATE_READY
DRDYNVC_STATE_FAILED

Function Documentation

WTSChannelGetHandleById()

FREERDP_API void* WTSChannelGetHandleById	(	freerdp_peer *	client,
		const UINT16	channel_id
	)

Here is the call graph for this function:

WTSChannelGetHandleByName()

FREERDP_API void* WTSChannelGetHandleByName	(	freerdp_peer *	client,
		const char *	channel_name
	)

Here is the call graph for this function:

WTSChannelGetId()

FREERDP_API UINT16 WTSChannelGetId	(	freerdp_peer *	client,
		const char *	channel_name
	)

Extended FreeRDP WTS functions for channel handling

Here is the call graph for this function:

Here is the caller graph for this function:

WTSChannelGetIdByHandle()

FREERDP_API UINT32 WTSChannelGetIdByHandle

(

HANDLE

hChannelHandle

)

Here is the caller graph for this function:

WTSChannelGetName()

FREERDP_API const char* WTSChannelGetName	(	freerdp_peer *	client,
		UINT16	channel_id
	)

Here is the call graph for this function:

WTSChannelGetOptions()

FREERDP_API INT64 WTSChannelGetOptions	(	freerdp_peer *	client,
		UINT16	channel_id
	)

Here is the call graph for this function:

WTSChannelSetHandleById()

FREERDP_API BOOL WTSChannelSetHandleById	(	freerdp_peer *	client,
		const UINT16	channel_id,
		void *	handle
	)

Here is the call graph for this function:

WTSChannelSetHandleByName()

FREERDP_API BOOL WTSChannelSetHandleByName	(	freerdp_peer *	client,
		const char *	channel_name,
		void *	handle
	)

Here is the call graph for this function:

WTSGetAcceptedChannelNames()

FREERDP_API char** WTSGetAcceptedChannelNames	(	freerdp_peer *	client,
		size_t *	count
	)

Here is the caller graph for this function:

WTSIsChannelJoinedById()

FREERDP_API BOOL WTSIsChannelJoinedById	(	freerdp_peer *	client,
		const UINT16	channel_id
	)

Here is the call graph for this function:

WTSIsChannelJoinedByName()

FREERDP_API BOOL WTSIsChannelJoinedByName	(	freerdp_peer *	client,
		const char *	channel_name
	)

Here is the call graph for this function:

WTSVirtualChannelManagerCheckFileDescriptor()

FREERDP_API BOOL WTSVirtualChannelManagerCheckFileDescriptor

(

HANDLE

hServer

)

Here is the call graph for this function:

Here is the caller graph for this function:

WTSVirtualChannelManagerCheckFileDescriptorEx()

FREERDP_API BOOL WTSVirtualChannelManagerCheckFileDescriptorEx	(	HANDLE	hServer,
		BOOL	autoOpen
	)

Here is the call graph for this function:

Here is the caller graph for this function:

WTSVirtualChannelManagerGetDrdynvcState()

FREERDP_API BYTE WTSVirtualChannelManagerGetDrdynvcState

(

HANDLE

hServer

)

Here is the caller graph for this function:

WTSVirtualChannelManagerGetEventHandle()

FREERDP_API HANDLE WTSVirtualChannelManagerGetEventHandle

(

HANDLE

hServer

)

Here is the call graph for this function:

Here is the caller graph for this function:

WTSVirtualChannelManagerIsChannelJoined()

FREERDP_API BOOL WTSVirtualChannelManagerIsChannelJoined	(	HANDLE	hServer,
		const char *	name
	)

Here is the call graph for this function:

Here is the caller graph for this function:

WTSVirtualChannelManagerOpen()

FREERDP_API BOOL WTSVirtualChannelManagerOpen

(

HANDLE

hServer

)

WTSVirtualChannelManager functions are FreeRDP extensions to the API.

Here is the call graph for this function:

Here is the caller graph for this function:

WTSVirtualChannelManagerSetDVCCreationCallback()

FREERDP_API void WTSVirtualChannelManagerSetDVCCreationCallback	(	HANDLE	hServer,
		psDVCCreationStatusCallback	cb,
		void *	userdata
	)