FreeRDP
freerdp Struct Reference

#include <freerdp.h>

Data Fields

ALIGN64 rdpContext * context
 
ALIGN64 RDP_CLIENT_ENTRY_POINTSpClientEntryPoints
 
UINT64 paddingA [16-2]
 
ALIGN64 rdpInput * input
 
ALIGN64 rdpUpdate * update
 
ALIGN64 rdpSettings * settings
 
ALIGN64 rdpAutoDetect * autodetect
 
UINT64 paddingB [32-20]
 
ALIGN64 size_t ContextSize
 
ALIGN64 pContextNew ContextNew
 
ALIGN64 pContextFree ContextFree
 
UINT64 paddingC [47-35]
 
ALIGN64 UINT ConnectionCallbackState
 
ALIGN64 pPreConnect PreConnect
 
ALIGN64 pPostConnect PostConnect
 
ALIGN64 pAuthenticate Authenticate
 
ALIGN64 pVerifyCertificate VerifyCertificate
 
ALIGN64 pVerifyChangedCertificate VerifyChangedCertificate
 
ALIGN64 pVerifyX509Certificate VerifyX509Certificate
 
ALIGN64 pLogonErrorInfo LogonErrorInfo
 
ALIGN64 pPostDisconnect PostDisconnect
 
ALIGN64 pAuthenticate GatewayAuthenticate
 
UINT64 paddingD [64-57]
 
ALIGN64 pSendChannelData SendChannelData
 
ALIGN64 pReceiveChannelData ReceiveChannelData
 
ALIGN64 pVerifyCertificateEx VerifyCertificateEx
 
ALIGN64 pVerifyChangedCertificateEx VerifyChangedCertificateEx
 
UINT64 paddingE [80-68]
 

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.

Field Documentation

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.

ALIGN64 rdpAutoDetect* freerdp::autodetect
ALIGN64 UINT freerdp::ConnectionCallbackState
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.

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.

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.

ALIGN64 size_t freerdp::ContextSize
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.

ALIGN64 rdpInput* freerdp::input
ALIGN64 pLogonErrorInfo freerdp::LogonErrorInfo

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

UINT64 freerdp::paddingA[16-2]
UINT64 freerdp::paddingB[32-20]
UINT64 freerdp::paddingC[47-35]
UINT64 freerdp::paddingD[64-57]
UINT64 freerdp::paddingE[80-68]
ALIGN64 RDP_CLIENT_ENTRY_POINTS* freerdp::pClientEntryPoints
ALIGN64 pPostConnect 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.

ALIGN64 pPostDisconnect freerdp::PostDisconnect

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

ALIGN64 pPreConnect 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.

ALIGN64 pReceiveChannelData freerdp::ReceiveChannelData
ALIGN64 pSendChannelData freerdp::SendChannelData
ALIGN64 rdpSettings* freerdp::settings

(offset 18) Pointer to a rdpSettings structure. Will be used to maintain the required RDP settings. Will be initialized by a call to freerdp_context_new()

ALIGN64 rdpUpdate* freerdp::update
ALIGN64 pVerifyCertificate freerdp::VerifyCertificate

(offset 51) Callback for certificate validation. Used to verify that an unknown certificate is trusted. DEPRECATED: Use VerifyChangedCertificateEx

ALIGN64 pVerifyCertificateEx freerdp::VerifyCertificateEx

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

ALIGN64 pVerifyChangedCertificate freerdp::VerifyChangedCertificate

(offset 52) Callback for changed certificate validation. Used when a certificate differs from stored fingerprint. DEPRECATED: Use VerifyChangedCertificateEx

ALIGN64 pVerifyChangedCertificateEx freerdp::VerifyChangedCertificateEx

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

ALIGN64 pVerifyX509Certificate freerdp::VerifyX509Certificate

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


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