#include <freerdp.h>

Data Fields
ALIGN64 rdpContext *	context

ALIGN64 RDP_CLIENT_ENTRY_POINTS *	pClientEntryPoints

UINT64	paddingA [16 - 2]

UINT64	paddingX [4]

ALIGN64 rdpHeartbeat *	heartbeat

UINT64	paddingB [32 - 21]

ALIGN64 size_t	ContextSize

ALIGN64 pContextNew	ContextNew

ALIGN64 pContextFree	ContextFree

UINT64	paddingC [47 - 35]

ALIGN64 UINT	ConnectionCallbackState

ALIGN64 pConnectCallback	PreConnect

ALIGN64 pConnectCallback	PostConnect

ALIGN64 pAuthenticate	Authenticate

ALIGN64 UINT64	reserved [2]

ALIGN64 pVerifyX509Certificate	VerifyX509Certificate

ALIGN64 pLogonErrorInfo	LogonErrorInfo

ALIGN64 pPostDisconnect	PostDisconnect

ALIGN64 pAuthenticate	GatewayAuthenticate

ALIGN64 pPresentGatewayMessage	PresentGatewayMessage

ALIGN64 pConnectCallback	Redirect

ALIGN64 pConnectCallback	LoadChannels

ALIGN64 pPostDisconnect	PostFinalDisconnect

UINT64	paddingD [64 - 61]

ALIGN64 pSendChannelData	SendChannelData

ALIGN64 pReceiveChannelData	ReceiveChannelData

ALIGN64 pVerifyCertificateEx	VerifyCertificateEx

ALIGN64 pVerifyChangedCertificateEx	VerifyChangedCertificateEx

ALIGN64 pSendChannelPacket	SendChannelPacket

ALIGN64 pAuthenticateEx	AuthenticateEx

ALIGN64 pChooseSmartcard	ChooseSmartcard

ALIGN64 pGetAccessToken	GetAccessToken

ALIGN64 pRetryDialog	RetryDialog

UINT64	paddingE [80 - 73]

Detailed Description

Defines the options for a given instance of RDP connection. This is built by the client and given to the FreeRDP library to create the connection with the expected options. It is allocated by a call to freerdp_new() and deallocated by a call to freerdp_free(). Some of its content need specific allocation/deallocation - see field description for details.

Definition at line 370 of file freerdp.h.

Field Documentation

◆ Authenticate

ALIGN64 pAuthenticate freerdp::Authenticate

(offset 50) Callback for authentication. It is used to get the username/password when it was not provided at connection time.

Definition at line 452 of file freerdp.h.

◆ AuthenticateEx

ALIGN64 pAuthenticateEx freerdp::AuthenticateEx

(offset 69) Callback for authentication. It is used to get the username/password. The reason argument tells why it was called.

Definition at line 537 of file freerdp.h.

◆ ChooseSmartcard

ALIGN64 pChooseSmartcard freerdp::ChooseSmartcard

Definition at line 542 of file freerdp.h.

◆ ConnectionCallbackState

ALIGN64 UINT freerdp::ConnectionCallbackState

Definition at line 438 of file freerdp.h.

◆ context

ALIGN64 rdpContext* freerdp::context

(offset 0) Pointer to a rdpContext structure. Client applications can use the ContextSize field to register a context bigger than the rdpContext structure. This allow clients to use additional context information. When using this capability, client application should ALWAYS declare their structure with the rdpContext field first, and any additional content following it. Can be allocated by a call to freerdp_context_new(). Must be deallocated by a call to freerdp_context_free() before deallocating the current instance.

Definition at line 373 of file freerdp.h.

◆ ContextFree

ALIGN64 pContextFree freerdp::ContextFree

(offset 34) Callback for context deallocation Can be set before calling freerdp_context_free() to have it executed before deallocation. Must be set to NULL if not needed.

Definition at line 432 of file freerdp.h.

◆ ContextNew

ALIGN64 pContextNew freerdp::ContextNew

(offset 33) Callback for context allocation Can be set before calling freerdp_context_new() to have it executed after allocation and initialization. Must be set to NULL if not needed.

Definition at line 426 of file freerdp.h.

◆ ContextSize

ALIGN64 size_t freerdp::ContextSize

Definition at line 415 of file freerdp.h.

◆ GatewayAuthenticate

ALIGN64 pAuthenticate freerdp::GatewayAuthenticate

(offset 56) Callback for gateway authentication. It is used to get the username/password when it was not provided at connection time.

Definition at line 482 of file freerdp.h.

◆ GetAccessToken

ALIGN64 pGetAccessToken freerdp::GetAccessToken

Definition at line 546 of file freerdp.h.

◆ heartbeat

ALIGN64 rdpHeartbeat* freerdp::heartbeat

Definition at line 410 of file freerdp.h.

◆ LoadChannels

ALIGN64 pConnectCallback freerdp::LoadChannels

(offset 59) callback for loading channel configuration. Might be called multiple times when redirection occurs.

Definition at line 498 of file freerdp.h.

◆ LogonErrorInfo

ALIGN64 pLogonErrorInfo freerdp::LogonErrorInfo

(offset 54) Callback for logon error info, important for logon system messages with RemoteApp

Definition at line 470 of file freerdp.h.

◆ paddingA

UINT64 freerdp::paddingA[16 - 2]

Definition at line 385 of file freerdp.h.

◆ paddingB

UINT64 freerdp::paddingB[32 - 21]

Definition at line 412 of file freerdp.h.

◆ paddingC

UINT64 freerdp::paddingC[47 - 35]

Definition at line 436 of file freerdp.h.

◆ paddingD

UINT64 freerdp::paddingD[64 - 61]

< (offset 60) callback for cleaning up resources allocated in PreConnect

This will be called after all instance related channels and threads have been stopped

Definition at line 509 of file freerdp.h.

◆ paddingE

UINT64 freerdp::paddingE[80 - 73]

Definition at line 551 of file freerdp.h.

◆ paddingX

UINT64 freerdp::paddingX[4]

Definition at line 408 of file freerdp.h.

◆ pClientEntryPoints

ALIGN64 RDP_CLIENT_ENTRY_POINTS* freerdp::pClientEntryPoints

Definition at line 383 of file freerdp.h.

◆ PostConnect

ALIGN64 pConnectCallback freerdp::PostConnect

(offset 49) Callback for post-connect operations. Can be set before calling freerdp_connect() to have it executed after the actual connection has succeeded. Must be set to NULL if not needed.

Definition at line 447 of file freerdp.h.

◆ PostDisconnect

ALIGN64 pPostDisconnect freerdp::PostDisconnect

(offset 55) Callback for cleaning up resources allocated by post connect callback.

This will be called before disconnecting and cleaning up the channels.

Definition at line 474 of file freerdp.h.

◆ PostFinalDisconnect

ALIGN64 pPostDisconnect freerdp::PostFinalDisconnect

Definition at line 503 of file freerdp.h.

◆ PreConnect

ALIGN64 pConnectCallback freerdp::PreConnect

(offset 48) Callback for pre-connect operations. Can be set before calling freerdp_connect() to have it executed before the actual connection happens. Must be set to NULL if not needed.

Definition at line 441 of file freerdp.h.

◆ PresentGatewayMessage

ALIGN64 pPresentGatewayMessage freerdp::PresentGatewayMessage

(offset 57) Callback for gateway consent messages. It is used to present consent messages to the user.

Definition at line 487 of file freerdp.h.

◆ ReceiveChannelData

ALIGN64 pReceiveChannelData freerdp::ReceiveChannelData

Definition at line 517 of file freerdp.h.

◆ Redirect

ALIGN64 pConnectCallback freerdp::Redirect

(offset 58) Callback for redirect operations. Can be set after rdp_client_disconnect_and_clear and applying redirection settings but before rdp_client_connect() to have it executed after the actual connection has succeeded. Must be set to NULL if not needed.

Definition at line 491 of file freerdp.h.

◆ reserved

ALIGN64 UINT64 freerdp::reserved[2]

Definition at line 463 of file freerdp.h.

◆ RetryDialog

ALIGN64 pRetryDialog freerdp::RetryDialog

Definition at line 549 of file freerdp.h.

◆ SendChannelData

ALIGN64 pSendChannelData freerdp::SendChannelData

Definition at line 512 of file freerdp.h.

◆ SendChannelPacket

ALIGN64 pSendChannelPacket freerdp::SendChannelPacket

Definition at line 532 of file freerdp.h.

◆ VerifyCertificateEx

ALIGN64 pVerifyCertificateEx freerdp::VerifyCertificateEx

(offset 66) Callback for certificate validation. Used to verify that an unknown certificate is trusted.

Definition at line 524 of file freerdp.h.

◆ VerifyChangedCertificateEx

ALIGN64 pVerifyChangedCertificateEx freerdp::VerifyChangedCertificateEx

(offset 67) Callback for changed certificate validation. Used when a certificate differs from stored fingerprint.

Definition at line 528 of file freerdp.h.

◆ VerifyX509Certificate

ALIGN64 pVerifyX509Certificate freerdp::VerifyX509Certificate

(offset 53) Callback for X509 certificate verification (PEM format)

Definition at line 466 of file freerdp.h.

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

freerdp.h

Data Fields