This is the FreeRDP settings module. More...

Data Structures
struct	TARGET_NET_ADDRESS

struct	ARC_CS_PRIVATE_PACKET

struct	ARC_SC_PRIVATE_PACKET

struct	ADDIN_ARGV

struct	rdp_ext_set

struct	BITMAP_CACHE_CELL_INFO

struct	BITMAP_CACHE_V2_CELL_INFO

struct	GLYPH_CACHE_DEFINITION

struct	MONITOR_DEF

struct	MONITOR_ATTRIBUTES

struct	rdpMonitor

struct	RDPDR_DEVICE

struct	RDPDR_DRIVE

struct	RDPDR_PRINTER

struct	RDPDR_SMARTCARD

struct	RDPDR_SERIAL

struct	RDPDR_PARALLEL

struct	rdpSettings

Macros
#define	FREERDP_SETTINGS_SERVER_MODE 0x00000001

#define	FREERDP_SETTINGS_REMOTE_MODE 0x00000002

#define	SURFCMDS_SET_SURFACE_BITS 0x00000002 /** @since version 3.7.0 */

#define	SURFCMDS_FRAME_MARKER 0x00000010 /** @since version 3.7.0 */

#define	SURFCMDS_STREAM_SURFACE_BITS 0x00000040 /** @since version 3.7.0 */

#define	RAIL_LEVEL_SUPPORTED 0x00000001

#define	RAIL_LEVEL_DOCKED_LANGBAR_SUPPORTED 0x00000002

#define	RAIL_LEVEL_SHELL_INTEGRATION_SUPPORTED 0x00000004

#define	RAIL_LEVEL_LANGUAGE_IME_SYNC_SUPPORTED 0x00000008

#define	RAIL_LEVEL_SERVER_TO_CLIENT_IME_SYNC_SUPPORTED 0x00000010

#define	RAIL_LEVEL_HIDE_MINIMIZED_APPS_SUPPORTED 0x00000020

#define	RAIL_LEVEL_WINDOW_CLOAKING_SUPPORTED 0x00000040

#define	RAIL_LEVEL_HANDSHAKE_EX_SUPPORTED 0x00000080

#define	PERF_FLAG_NONE 0x00000000

#define	PERF_DISABLE_WALLPAPER 0x00000001

#define	PERF_DISABLE_FULLWINDOWDRAG 0x00000002

#define	PERF_DISABLE_MENUANIMATIONS 0x00000004

#define	PERF_DISABLE_THEMING 0x00000008

#define	PERF_DISABLE_CURSOR_SHADOW 0x00000020

#define	PERF_DISABLE_CURSORSETTINGS 0x00000040

#define	PERF_ENABLE_FONT_SMOOTHING 0x00000080

#define	PERF_ENABLE_DESKTOP_COMPOSITION 0x00000100

#define	CONNECTION_TYPE_INVALID

#define	CONNECTION_TYPE_MODEM 0x01

#define	CONNECTION_TYPE_BROADBAND_LOW 0x02

#define	CONNECTION_TYPE_SATELLITE 0x03

#define	CONNECTION_TYPE_BROADBAND_HIGH 0x04

#define	CONNECTION_TYPE_WAN 0x05

#define	CONNECTION_TYPE_LAN 0x06

#define	CONNECTION_TYPE_AUTODETECT 0x07

#define	CS_CORE 0xC001

#define	CS_SECURITY 0xC002

#define	CS_NET 0xC003

#define	CS_CLUSTER 0xC004

#define	CS_MONITOR 0xC005

#define	CS_MCS_MSGCHANNEL 0xC006

#define	CS_MONITOR_EX 0xC008

#define	CS_UNUSED1 0xC00C

#define	CS_MULTITRANSPORT 0xC00A

#define	SC_CORE 0x0C01

#define	SC_SECURITY 0x0C02

#define	SC_NET 0x0C03

#define	SC_MCS_MSGCHANNEL 0x0C04

#define	SC_MULTITRANSPORT 0x0C08

#define	RNS_UD_COLOR_4BPP 0xCA00

#define	RNS_UD_COLOR_8BPP 0xCA01

#define	RNS_UD_COLOR_16BPP_555 0xCA02

#define	RNS_UD_COLOR_16BPP_565 0xCA03

#define	RNS_UD_COLOR_24BPP 0xCA04

#define	RNS_UD_SAS_DEL 0xAA03

#define	RNS_UD_24BPP_SUPPORT 0x0001

#define	RNS_UD_16BPP_SUPPORT 0x0002

#define	RNS_UD_15BPP_SUPPORT 0x0004

#define	RNS_UD_32BPP_SUPPORT 0x0008

#define	AUDIO_MODE_REDIRECT 0 /* Bring to this computer */

#define	AUDIO_MODE_PLAY_ON_SERVER 1 /* Leave at remote computer */

#define	AUDIO_MODE_NONE 2 /* Do not play */

#define	RNS_UD_CS_SUPPORT_ERRINFO_PDU 0x0001

#define	RNS_UD_CS_WANT_32BPP_SESSION 0x0002

#define	RNS_UD_CS_SUPPORT_STATUSINFO_PDU 0x0004

#define	RNS_UD_CS_STRONG_ASYMMETRIC_KEYS 0x0008

#define	RNS_UD_CS_RELATIVE_MOUSE_INPUT 0x0010

#define	RNS_UD_CS_VALID_CONNECTION_TYPE 0x0020

#define	RNS_UD_CS_SUPPORT_MONITOR_LAYOUT_PDU 0x0040

#define	RNS_UD_CS_SUPPORT_NETCHAR_AUTODETECT 0x0080

#define	RNS_UD_CS_SUPPORT_DYNVC_GFX_PROTOCOL 0x0100

#define	RNS_UD_CS_SUPPORT_DYNAMIC_TIME_ZONE 0x0200

#define	RNS_UD_CS_SUPPORT_HEARTBEAT_PDU 0x0400

#define	RNS_UD_CS_SUPPORT_SKIP_CHANNELJOIN 0x0800

#define	RNS_UD_SC_EDGE_ACTIONS_SUPPORTED_V1 0x00000001

#define	RNS_UD_SC_DYNAMIC_DST_SUPPORTED 0x00000002

#define	RNS_UD_SC_EDGE_ACTIONS_SUPPORTED_V2 0x00000004

#define	RNS_UD_SC_SKIP_CHANNELJOIN_SUPPORTED 0x00000008

#define	REDIRECTION_SUPPORTED 0x00000001

#define	REDIRECTED_SESSIONID_FIELD_VALID 0x00000002

#define	REDIRECTED_SMARTCARD 0x00000040

#define	ServerSessionRedirectionVersionMask 0x0000003c

#define	REDIRECTION_VERSION1 0x00

#define	REDIRECTION_VERSION2 0x01

#define	REDIRECTION_VERSION3 0x02

#define	REDIRECTION_VERSION4 0x03

#define	REDIRECTION_VERSION5 0x04

#define	REDIRECTION_VERSION6 0x05

#define	MONITOR_PRIMARY 0x00000001

#define	ENCRYPTION_METHOD_NONE 0x00000000

#define	ENCRYPTION_METHOD_40BIT 0x00000001

#define	ENCRYPTION_METHOD_128BIT 0x00000002

#define	ENCRYPTION_METHOD_56BIT 0x00000008

#define	ENCRYPTION_METHOD_FIPS 0x00000010

#define	ENCRYPTION_LEVEL_NONE 0x00000000

#define	ENCRYPTION_LEVEL_LOW 0x00000001

#define	ENCRYPTION_LEVEL_CLIENT_COMPATIBLE 0x00000002

#define	ENCRYPTION_LEVEL_HIGH 0x00000003

#define	ENCRYPTION_LEVEL_FIPS 0x00000004

#define	TRANSPORT_TYPE_UDP_FECR 0x00000001

#define	TRANSPORT_TYPE_UDP_FECL 0x00000004

#define	TRANSPORT_TYPE_UDP_PREFERRED 0x00000100

#define	SOFTSYNC_TCP_TO_UDP 0x00000200

#define	CHANNEL_OPTION_INITIALIZED 0x80000000

#define	CHANNEL_OPTION_ENCRYPT_RDP 0x40000000

#define	CHANNEL_OPTION_ENCRYPT_SC 0x20000000

#define	CHANNEL_OPTION_ENCRYPT_CS 0x10000000

#define	CHANNEL_OPTION_PRI_HIGH 0x08000000

#define	CHANNEL_OPTION_PRI_MED 0x04000000

#define	CHANNEL_OPTION_PRI_LOW 0x02000000

#define	CHANNEL_OPTION_COMPRESS_RDP 0x00800000

#define	CHANNEL_OPTION_COMPRESS 0x00400000

#define	CHANNEL_OPTION_SHOW_PROTOCOL 0x00200000

#define	CHANNEL_REMOTE_CONTROL_PERSISTENT 0x00100000

#define	VCCAPS_NO_COMPR 0x00000000

#define	VCCAPS_COMPR_SC 0x00000001

#define	VCCAPS_COMPR_CS_8K 0x00000002

#define	LARGE_POINTER_FLAG_96x96 0x00000001

#define	LARGE_POINTER_FLAG_384x384 0x00000002

#define	AUTO_RECONNECT_VERSION_1 0x00000001

#define	MSTSC_COOKIE_MAX_LENGTH 9

#define	DEFAULT_COOKIE_MAX_LENGTH 0xFF

#define	TS_CAPS_PROTOCOLVERSION 0x200 /** @since version 3.6.0 */

#define	NEG_DSTBLT_INDEX 0x00

#define	NEG_PATBLT_INDEX 0x01

#define	NEG_SCRBLT_INDEX 0x02

#define	NEG_MEMBLT_INDEX 0x03

#define	NEG_MEM3BLT_INDEX 0x04

#define	NEG_ATEXTOUT_INDEX 0x05

#define	NEG_AEXTTEXTOUT_INDEX 0x06 /* Must be ignored */

#define	NEG_DRAWNINEGRID_INDEX 0x07 /* Must be ignored */

#define	NEG_LINETO_INDEX 0x08

#define	NEG_MULTI_DRAWNINEGRID_INDEX 0x09

#define	NEG_OPAQUE_RECT_INDEX 0x0A /* Must be ignored */

#define	NEG_SAVEBITMAP_INDEX 0x0B

#define	NEG_WTEXTOUT_INDEX 0x0C /* Must be ignored */

#define	NEG_MEMBLT_V2_INDEX 0x0D /* Must be ignored */

#define	NEG_MEM3BLT_V2_INDEX 0x0E /* Must be ignored */

#define	NEG_MULTIDSTBLT_INDEX 0x0F

#define	NEG_MULTIPATBLT_INDEX 0x10

#define	NEG_MULTISCRBLT_INDEX 0x11

#define	NEG_MULTIOPAQUERECT_INDEX 0x12

#define	NEG_FAST_INDEX_INDEX 0x13

#define	NEG_POLYGON_SC_INDEX 0x14

#define	NEG_POLYGON_CB_INDEX 0x15

#define	NEG_POLYLINE_INDEX 0x16

#define	NEG_UNUSED23_INDEX 0x17 /* Must be ignored */

#define	NEG_FAST_GLYPH_INDEX 0x18

#define	NEG_ELLIPSE_SC_INDEX 0x19

#define	NEG_ELLIPSE_CB_INDEX 0x1A

#define	NEG_GLYPH_INDEX_INDEX 0x1B

#define	NEG_GLYPH_WEXTTEXTOUT_INDEX 0x1C /* Must be ignored */

#define	NEG_GLYPH_WLONGTEXTOUT_INDEX 0x1D /* Must be ignored */

#define	NEG_GLYPH_WLONGEXTTEXTOUT_INDEX 0x1E /* Must be ignored */

#define	NEG_UNUSED31_INDEX 0x1F /* Must be ignored */

#define	GLYPH_SUPPORT_NONE 0x0000

#define	GLYPH_SUPPORT_PARTIAL 0x0001

#define	GLYPH_SUPPORT_FULL 0x0002

#define	GLYPH_SUPPORT_ENCODE 0x0003

#define	TSC_PROXY_MODE_NONE_DIRECT 0x0

#define	TSC_PROXY_MODE_DIRECT 0x1

#define	TSC_PROXY_MODE_DETECT 0x2

#define	TSC_PROXY_MODE_DEFAULT 0x3

#define	TSC_PROXY_MODE_NONE_DETECT 0x4

#define	TSC_PROXY_CREDS_MODE_USERPASS 0x0

#define	TSC_PROXY_CREDS_MODE_SMARTCARD 0x1

#define	TSC_PROXY_CREDS_MODE_ANY 0x2

#define	KEYBOARD_HOOK_LOCAL 0

#define	KEYBOARD_HOOK_REMOTE 1

#define	KEYBOARD_HOOK_FULLSCREEN_ONLY 2

#define	LOGON_MSG_DISCONNECT_REFUSED 0xFFFFFFF9

#define	LOGON_MSG_NO_PERMISSION 0xFFFFFFFA

#define	LOGON_MSG_BUMP_OPTIONS 0xFFFFFFFB

#define	LOGON_MSG_RECONNECT_OPTIONS 0xFFFFFFFC

#define	LOGON_MSG_SESSION_TERMINATE 0xFFFFFFFD

#define	LOGON_MSG_SESSION_CONTINUE 0xFFFFFFFE

#define	LOGON_FAILED_BAD_PASSWORD 0x00000000

#define	LOGON_FAILED_UPDATE_PASSWORD 0x00000001

#define	LOGON_FAILED_OTHER 0x00000002

#define	LOGON_WARNING 0x00000003

#define	STATUS_FINDING_DESTINATION 0x00000401

#define	STATUS_LOADING_DESTINATION 0x00000402

#define	STATUS_BRINGING_SESSION_ONLINE 0x00000403

#define	STATUS_REDIRECTING_TO_DESTINATION 0x00000404

#define	STATUS_VM_LOADING 0x00000501

#define	STATUS_VM_WAKING 0x00000502

#define	STATUS_VM_BOOTING 0x00000503

#define	PACKET_COMPR_TYPE_8K 0x00

#define	PACKET_COMPR_TYPE_64K 0x01

#define	PACKET_COMPR_TYPE_RDP6 0x02

#define	PACKET_COMPR_TYPE_RDP61 0x03

#define	PACKET_COMPR_TYPE_RDP8 0x04

#define	ORIENTATION_LANDSCAPE 0

#define	ORIENTATION_PORTRAIT 90

#define	ORIENTATION_LANDSCAPE_FLIPPED 180

#define	ORIENTATION_PORTRAIT_FLIPPED 270

#define	CLIPRDR_FLAG_LOCAL_TO_REMOTE 0x01

#define	CLIPRDR_FLAG_LOCAL_TO_REMOTE_FILES 0x02

#define	CLIPRDR_FLAG_REMOTE_TO_LOCAL 0x10

#define	CLIPRDR_FLAG_REMOTE_TO_LOCAL_FILES 0x20

#define	CLIPRDR_FLAG_DEFAULT_MASK

#define	RDPDR_DTYP_SERIAL 0x00000001

#define	RDPDR_DTYP_PARALLEL 0x00000002

#define	RDPDR_DTYP_PRINT 0x00000004

#define	RDPDR_DTYP_FILESYSTEM 0x00000008

#define	RDPDR_DTYP_SMARTCARD 0x00000020

#define	PROXY_TYPE_NONE 0

#define	PROXY_TYPE_HTTP 1

#define	PROXY_TYPE_SOCKS 2

#define	PROXY_TYPE_IGNORE 0xFFFF

#define	THREADING_FLAGS_DISABLE_THREADS 0x00000001

#define	FREERDP_SETTINGS_SERVER_MODE 0x00000001

#define	SETTINGS_DEPRECATED(x) WINPR_DEPRECATED(x)

Enumerations
enum	RDP_VERSION { RDP_VERSION_4 = 0x00080001 , RDP_VERSION_5_PLUS = 0x00080004 , RDP_VERSION_10_0 = 0x00080005 , RDP_VERSION_10_1 = 0x00080006 , RDP_VERSION_10_2 = 0x00080007 , RDP_VERSION_10_3 = 0x00080008 , RDP_VERSION_10_4 = 0x00080009 , RDP_VERSION_10_5 = 0x0008000a , RDP_VERSION_10_6 = 0x0008000b , RDP_VERSION_10_7 = 0x0008000C , RDP_VERSION_10_8 = 0x0008000D , RDP_VERSION_10_9 = 0x0008000E , RDP_VERSION_10_10 = 0x0008000F , RDP_VERSION_10_11 = 0x00080010 , RDP_VERSION_10_12 = 0x00080011 }

enum	rdp_settings_type { RDP_SETTINGS_TYPE_BOOL , RDP_SETTINGS_TYPE_UINT16 , RDP_SETTINGS_TYPE_INT16 , RDP_SETTINGS_TYPE_UINT32 , RDP_SETTINGS_TYPE_INT32 , RDP_SETTINGS_TYPE_UINT64 , RDP_SETTINGS_TYPE_INT64 , RDP_SETTINGS_TYPE_STRING , RDP_SETTINGS_TYPE_POINTER }

Functions
FREERDP_API void	freerdp_settings_free (rdpSettings *settings)
	Free a settings struct with all data in it. More...

FREERDP_API rdpSettings *	freerdp_settings_new (DWORD flags)
	creates a new setting struct More...

FREERDP_API rdpSettings *	freerdp_settings_clone (const rdpSettings *settings)
	Creates a deep copy of settings. More...

FREERDP_API BOOL	freerdp_settings_copy (rdpSettings dst, const rdpSettings src)
	Deep copies settings from src to dst. More...

FREERDP_API BOOL	freerdp_settings_copy_item (rdpSettings dst, const rdpSettings src, SSIZE_T id)
	copies one setting identified by id from src to dst More...

FREERDP_API void	freerdp_settings_dump (wLog log, DWORD level, const rdpSettings settings)
	Dumps the contents of a settings struct to a WLog logger. More...

FREERDP_API BOOL	freerdp_settings_print_diff (wLog log, DWORD level, const rdpSettings src, const rdpSettings *other)
	Dumps the difference between two settings structs to a WLog. More...

FREERDP_API void	freerdp_addin_argv_free (ADDIN_ARGV *args)

FREERDP_API ADDIN_ARGV *	freerdp_addin_argv_new (size_t argc, const char *argv[])

FREERDP_API ADDIN_ARGV *	freerdp_addin_argv_clone (const ADDIN_ARGV *args)

FREERDP_API BOOL	freerdp_addin_argv_add_argument (ADDIN_ARGV args, const char argument)

FREERDP_API BOOL	freerdp_addin_argv_add_argument_ex (ADDIN_ARGV args, const char argument, size_t len)

FREERDP_API BOOL	freerdp_addin_argv_del_argument (ADDIN_ARGV args, const char argument)

FREERDP_API int	freerdp_addin_set_argument (ADDIN_ARGV args, const char argument)

FREERDP_API int	freerdp_addin_replace_argument (ADDIN_ARGV args, const char previous, const char *argument)

FREERDP_API int	freerdp_addin_set_argument_value (ADDIN_ARGV args, const char option, const char *value)

FREERDP_API int	freerdp_addin_replace_argument_value (ADDIN_ARGV args, const char previous, const char option, const char value)

FREERDP_API BOOL	freerdp_device_collection_add (rdpSettings settings, RDPDR_DEVICE device)

FREERDP_API BOOL	freerdp_device_collection_del (rdpSettings settings, const RDPDR_DEVICE device)
	Removed a device from the settings, returns ownership of the allocated device to caller. More...

FREERDP_API RDPDR_DEVICE *	freerdp_device_collection_find (rdpSettings settings, const char name)

FREERDP_API RDPDR_DEVICE *	freerdp_device_collection_find_type (rdpSettings *settings, UINT32 type)

FREERDP_API void	freerdp_device_free (RDPDR_DEVICE *device)

FREERDP_API RDPDR_DEVICE *	freerdp_device_new (UINT32 Type, size_t count, const char *args[])

FREERDP_API RDPDR_DEVICE *	freerdp_device_clone (const RDPDR_DEVICE *device)

FREERDP_API BOOL	freerdp_device_equal (const RDPDR_DEVICE one, const RDPDR_DEVICE other)

FREERDP_API void	freerdp_device_collection_free (rdpSettings *settings)

FREERDP_API BOOL	freerdp_static_channel_collection_add (rdpSettings settings, ADDIN_ARGV channel)

FREERDP_API BOOL	freerdp_static_channel_collection_del (rdpSettings settings, const char name)

FREERDP_API ADDIN_ARGV *	freerdp_static_channel_collection_find (rdpSettings settings, const char name)

FREERDP_API void	freerdp_static_channel_collection_free (rdpSettings *settings)

FREERDP_API BOOL	freerdp_dynamic_channel_collection_add (rdpSettings settings, ADDIN_ARGV channel)

FREERDP_API BOOL	freerdp_dynamic_channel_collection_del (rdpSettings settings, const char name)

FREERDP_API ADDIN_ARGV *	freerdp_dynamic_channel_collection_find (const rdpSettings settings, const char name)

FREERDP_API void	freerdp_dynamic_channel_collection_free (rdpSettings *settings)

FREERDP_API void	freerdp_capability_buffer_free (rdpSettings *settings)

FREERDP_API BOOL	freerdp_capability_buffer_copy (rdpSettings settings, const rdpSettings src)

FREERDP_API void	freerdp_server_license_issuers_free (rdpSettings *settings)

FREERDP_API BOOL	freerdp_server_license_issuers_copy (rdpSettings settings, char *addresses, UINT32 count)

FREERDP_API void	freerdp_target_net_addresses_free (rdpSettings *settings)

FREERDP_API BOOL	freerdp_target_net_addresses_copy (rdpSettings settings, char *addresses, UINT32 count)

FREERDP_API void	freerdp_performance_flags_make (rdpSettings *settings)

FREERDP_API void	freerdp_performance_flags_split (rdpSettings *settings)

FREERDP_API BOOL	freerdp_set_gateway_usage_method (rdpSettings *settings, UINT32 GatewayUsageMethod)

FREERDP_API void	freerdp_update_gateway_usage_method (rdpSettings *settings, UINT32 GatewayEnabled, UINT32 GatewayBypassLocal)

FREERDP_API BOOL	freerdp_settings_are_valid (const rdpSettings *settings)
	Returns TRUE if settings are in a valid state, FALSE otherwise. More...

FREERDP_API BOOL	freerdp_settings_get_bool (const rdpSettings *settings, FreeRDP_Settings_Keys_Bool id)
	Returns a boolean settings value. More...

FREERDP_API BOOL	freerdp_settings_set_bool (rdpSettings *settings, FreeRDP_Settings_Keys_Bool id, BOOL param)
	Sets a BOOL settings value. More...

FREERDP_API INT16	freerdp_settings_get_int16 (const rdpSettings *settings, FreeRDP_Settings_Keys_Int16 id)
	Returns a INT16 settings value. More...

FREERDP_API BOOL	freerdp_settings_set_int16 (rdpSettings *settings, FreeRDP_Settings_Keys_Int16 id, INT16 param)
	Sets a INT16 settings value. More...

FREERDP_API UINT16	freerdp_settings_get_uint16 (const rdpSettings *settings, FreeRDP_Settings_Keys_UInt16 id)
	Returns a UINT16 settings value. More...

FREERDP_API BOOL	freerdp_settings_set_uint16 (rdpSettings *settings, FreeRDP_Settings_Keys_UInt16 id, UINT16 param)
	Sets a UINT16 settings value. More...

FREERDP_API INT32	freerdp_settings_get_int32 (const rdpSettings *settings, FreeRDP_Settings_Keys_Int32 id)
	Returns a INT32 settings value. More...

FREERDP_API BOOL	freerdp_settings_set_int32 (rdpSettings *settings, FreeRDP_Settings_Keys_Int32 id, INT32 param)
	Sets a INT32 settings value. More...

FREERDP_API UINT32	freerdp_settings_get_uint32 (const rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id)
	Returns a UINT32 settings value. More...

FREERDP_API BOOL	freerdp_settings_set_uint32 (rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id, UINT32 param)
	Sets a UINT32 settings value. More...

FREERDP_API INT64	freerdp_settings_get_int64 (const rdpSettings *settings, FreeRDP_Settings_Keys_Int64 id)
	Returns a INT64 settings value. More...

FREERDP_API BOOL	freerdp_settings_set_int64 (rdpSettings *settings, FreeRDP_Settings_Keys_Int64 id, INT64 param)
	Sets a INT64 settings value. More...

FREERDP_API UINT64	freerdp_settings_get_uint64 (const rdpSettings *settings, FreeRDP_Settings_Keys_UInt64 id)
	Returns a UINT64 settings value. More...

FREERDP_API BOOL	freerdp_settings_set_uint64 (rdpSettings *settings, FreeRDP_Settings_Keys_UInt64 id, UINT64 param)
	Sets a UINT64 settings value. More...

FREERDP_API const char *	freerdp_settings_get_string (const rdpSettings *settings, FreeRDP_Settings_Keys_String id)
	Returns a immutable string settings value. More...

FREERDP_API char *	freerdp_settings_get_string_writable (rdpSettings *settings, FreeRDP_Settings_Keys_String id)
	Returns a string settings value. More...

FREERDP_API BOOL	freerdp_settings_set_string_len (rdpSettings settings, FreeRDP_Settings_Keys_String id, const char param, size_t len)
	Sets a string settings value. The param is copied. More...

FREERDP_API BOOL	freerdp_settings_set_string (rdpSettings settings, FreeRDP_Settings_Keys_String id, const char param)
	Sets a string settings value. The param is copied. More...

FREERDP_API BOOL	freerdp_settings_append_string (rdpSettings settings, FreeRDP_Settings_Keys_String id, const char separator, const char *param)
	appends a string to a settings value. The param is copied. If the initial value of the setting was not empty, More...

FREERDP_API BOOL	freerdp_settings_set_string_from_utf16 (rdpSettings settings, FreeRDP_Settings_Keys_String id, const WCHAR param)
	Sets a string settings value. The param is converted to UTF-8 and the copy stored. More...

FREERDP_API BOOL	freerdp_settings_set_string_from_utf16N (rdpSettings settings, FreeRDP_Settings_Keys_String id, const WCHAR param, size_t length)
	Sets a string settings value. The param is converted to UTF-8 and the copy stored. More...

FREERDP_API WCHAR *	freerdp_settings_get_string_as_utf16 (const rdpSettings settings, FreeRDP_Settings_Keys_String id, size_t pCharLen)
	Return an allocated UTF16 string. More...

FREERDP_API const void *	freerdp_settings_get_pointer (const rdpSettings *settings, FreeRDP_Settings_Keys_Pointer id)
	Returns a immutable pointer settings value. More...

FREERDP_API void *	freerdp_settings_get_pointer_writable (rdpSettings *settings, FreeRDP_Settings_Keys_Pointer id)
	Returns a mutable pointer settings value. More...

FREERDP_API BOOL	freerdp_settings_set_pointer (rdpSettings settings, FreeRDP_Settings_Keys_Pointer id, const void data)
	Set a pointer to value data. More...

FREERDP_API BOOL	freerdp_settings_set_pointer_len (rdpSettings settings, FreeRDP_Settings_Keys_Pointer id, const void data, size_t len)
	Set a pointer to value data. More...

FREERDP_API const void *	freerdp_settings_get_pointer_array (const rdpSettings *settings, FreeRDP_Settings_Keys_Pointer id, size_t offset)

FREERDP_API void *	freerdp_settings_get_pointer_array_writable (const rdpSettings *settings, FreeRDP_Settings_Keys_Pointer id, size_t offset)

FREERDP_API BOOL	freerdp_settings_set_pointer_array (rdpSettings settings, FreeRDP_Settings_Keys_Pointer id, size_t offset, const void data)

FREERDP_API BOOL	freerdp_settings_set_value_for_name (rdpSettings settings, const char name, const char *value)

FREERDP_API SSIZE_T	freerdp_settings_get_key_for_name (const char *value)
	Get a key index for the name string of that key. More...

FREERDP_API SSIZE_T	freerdp_settings_get_type_for_name (const char *value)
	Get a key type for the name string of that key. More...

FREERDP_API SSIZE_T	freerdp_settings_get_type_for_key (SSIZE_T key)
	Get a key type for the key index. More...

FREERDP_API const char *	freerdp_settings_get_type_name_for_key (SSIZE_T key)
	Returns the type name for a key. More...

FREERDP_API const char *	freerdp_settings_get_type_name_for_type (SSIZE_T type)
	Returns the type name for a type. More...

FREERDP_API const char *	freerdp_settings_get_name_for_key (SSIZE_T key)
	Returns the type name for a key. More...

FREERDP_API UINT32	freerdp_settings_get_codecs_flags (const rdpSettings *settings)
	helper function to get a mask of supported codec flags. More...

FREERDP_API BOOL	freerdp_settings_update_from_caps (rdpSettings settings, const BYTE capsFlags, const BYTE *capsData, const UINT32 capsSizes, UINT32 capsCount, BOOL serverReceivedCaps)
	Parse capability data and apply to settings. More...

FREERDP_API const char *	freerdp_settings_get_server_name (const rdpSettings *settings)
	A helper function to return the correct server name. More...

FREERDP_API const char *	freerdp_rail_support_flags_to_string (UINT32 flags, char *buffer, size_t length)
	Returns a stringified representation of RAIL support flags. More...

FREERDP_API const char *	freerdp_rdp_version_string (UINT32 version)
	Returns a stringified representation of the RDP protocol version. More...

FREERDP_API const char *	freerdp_rdpdr_dtyp_string (UINT32 type)
	Returns a string representation of RDPDR_DTYP_*. More...

FREERDP_API const char *	freerdp_encryption_level_string (UINT32 EncryptionLevel)

FREERDP_API const char *	freerdp_encryption_methods_string (UINT32 EncryptionLevel, char *buffer, size_t size)

FREERDP_API const char *	freerdp_supported_color_depths_string (UINT16 mask, char *buffer, size_t size)
	returns a string representation of RNS_UD_XXBPP_SUPPORT values More...

FREERDP_API char *	freerdp_settings_get_config_path (void)
	return the configuration directory for the library More...

Detailed Description

This is the FreeRDP settings module.

FreeRDP: A Remote Desktop Protocol Implementation RDP Settings

Copyright 2009-2011 Jay Sorg Copyright 2010-2012 Marc-Andre Moreau marca.nosp@m.ndre.nosp@m..more.nosp@m.au@g.nosp@m.mail..nosp@m.com Copyright 2016 Armin Novak armin.nosp@m..nov.nosp@m.ak@gm.nosp@m.ail..nosp@m.com Copyright 2023 Armin Novak anova.nosp@m.k@th.nosp@m.incas.nosp@m.t.co.nosp@m.m Copyright 2023 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.

Settings are used to store configuration data for an RDP connection. There are 3 different settings for each client and server:

The initial connection supplied by the user
The settings sent from client or server during capability exchange
The settings merged from the capability exchange and the initial configuration.

The lifetime of the settings is as follows:

Initial configuration is saved and will be valid for the whole application lifecycle
The client or server settings from the other end are valid from capability exchange until the connection is ended (disconnect/redirect/...)
The merged settings are created from the initial configuration and server settings and have the same lifetime, until the connection ends

So, when accessing the settings always ensure to know which one you are operating on! (this is especially important for the proxy where you have a RDP client and RDP server in the same application context)

FreeRDP: A Remote Desktop Protocol Implementation RDP Settings

Copyright 2009-2011 Jay Sorg Copyright 2010-2012 Marc-Andre Moreau marca.nosp@m.ndre.nosp@m..more.nosp@m.au@g.nosp@m.mail..nosp@m.com Copyright 2016 Armin Novak armin.nosp@m..nov.nosp@m.ak@gm.nosp@m.ail..nosp@m.com Copyright 2023 Armin Novak anova.nosp@m.k@th.nosp@m.incas.nosp@m.t.co.nosp@m.m Copyright 2023 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.

FreeRDP: A Remote Desktop Protocol Implementation Internal settings header for functions not exported

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.

Data Structure Documentation

◆ TARGET_NET_ADDRESS

struct TARGET_NET_ADDRESS

Definition at line 290 of file settings_types.h.

Data Fields
LPWSTR	Address
UINT32	Length

◆ ARC_CS_PRIVATE_PACKET

struct ARC_CS_PRIVATE_PACKET

Definition at line 342 of file settings_types.h.

Data Fields
UINT32	cbLen
UINT32	logonId
BYTE	securityVerifier[16]
UINT32	version

◆ ARC_SC_PRIVATE_PACKET

struct ARC_SC_PRIVATE_PACKET

Definition at line 351 of file settings_types.h.

Data Fields
BYTE	arcRandomBits[16]
UINT32	cbLen
UINT32	logonId
UINT32	version

◆ ADDIN_ARGV

struct ADDIN_ARGV

Definition at line 361 of file settings_types.h.

Data Fields
int	argc
char **	argv

◆ rdp_ext_set

struct rdp_ext_set

Definition at line 369 of file settings_types.h.

Data Fields
void *	data
char	name[256]

◆ BITMAP_CACHE_CELL_INFO

struct BITMAP_CACHE_CELL_INFO

Definition at line 377 of file settings_types.h.

Data Fields
UINT16	maxSize
UINT16	numEntries

◆ BITMAP_CACHE_V2_CELL_INFO

struct BITMAP_CACHE_V2_CELL_INFO

Definition at line 383 of file settings_types.h.

Data Fields
UINT32	numEntries
BOOL	persistent

◆ GLYPH_CACHE_DEFINITION

struct GLYPH_CACHE_DEFINITION

Definition at line 391 of file settings_types.h.

Data Fields
UINT16	cacheEntries
UINT16	cacheMaximumCellSize

◆ MONITOR_DEF

struct MONITOR_DEF

Definition at line 399 of file settings_types.h.

Data Fields
INT32	bottom
UINT32	flags
INT32	left
INT32	right
INT32	top

◆ MONITOR_ATTRIBUTES

struct MONITOR_ATTRIBUTES

Definition at line 408 of file settings_types.h.

Data Fields
UINT32	desktopScaleFactor
UINT32	deviceScaleFactor
UINT32	orientation
UINT32	physicalHeight
UINT32	physicalWidth

◆ rdpMonitor

struct rdpMonitor

Definition at line 417 of file settings_types.h.

Collaboration diagram for rdpMonitor:

[legend]

Data Fields
MONITOR_ATTRIBUTES	attributes
INT32	height
UINT32	is_primary
UINT32	orig_screen
INT32	width
INT32	x
INT32	y

◆ RDPDR_DEVICE

struct RDPDR_DEVICE

Definition at line 435 of file settings_types.h.

Data Fields
UINT32	Id
char *	Name
UINT32	Type

◆ RDPDR_DRIVE

struct RDPDR_DRIVE

Definition at line 442 of file settings_types.h.

Collaboration diagram for RDPDR_DRIVE:

[legend]

Data Fields
BOOL	automount
RDPDR_DEVICE	device
char *	Path

◆ RDPDR_PRINTER

struct RDPDR_PRINTER

Definition at line 449 of file settings_types.h.

Collaboration diagram for RDPDR_PRINTER:

[legend]

Data Fields
RDPDR_DEVICE	device
char *	DriverName
BOOL	IsDefault

◆ RDPDR_SMARTCARD

struct RDPDR_SMARTCARD

Definition at line 456 of file settings_types.h.

Collaboration diagram for RDPDR_SMARTCARD:

[legend]

Data Fields
RDPDR_DEVICE	device

◆ RDPDR_SERIAL

struct RDPDR_SERIAL

Definition at line 461 of file settings_types.h.

Collaboration diagram for RDPDR_SERIAL:

[legend]

Data Fields
RDPDR_DEVICE	device
char *	Driver
char *	Path
char *	Permissive

◆ RDPDR_PARALLEL

struct RDPDR_PARALLEL

Definition at line 469 of file settings_types.h.

Collaboration diagram for RDPDR_PARALLEL:

[legend]

Data Fields
RDPDR_DEVICE	device
char *	Path

Macro Definition Documentation

◆ CLIPRDR_FLAG_DEFAULT_MASK

#define CLIPRDR_FLAG_DEFAULT_MASK

Value:

(CLIPRDR_FLAG_LOCAL_TO_REMOTE | CLIPRDR_FLAG_LOCAL_TO_REMOTE_FILES | \

CLIPRDR_FLAG_REMOTE_TO_LOCAL | CLIPRDR_FLAG_REMOTE_TO_LOCAL_FILES)

Definition at line 337 of file settings_types.h.

◆ CONNECTION_TYPE_INVALID

#define CONNECTION_TYPE_INVALID

Value:

0x00

Definition at line 74 of file settings_types.h.

◆ FREERDP_SETTINGS_SERVER_MODE [1/2]

#define FREERDP_SETTINGS_SERVER_MODE 0x00000001

rdpSettings creation flags

Definition at line 80 of file include/freerdp/settings.h.

◆ FREERDP_SETTINGS_SERVER_MODE [2/2]

#define FREERDP_SETTINGS_SERVER_MODE 0x00000001

rdpSettings creation flags

Definition at line 499 of file settings_types.h.

Function Documentation

◆ freerdp_device_collection_del()

FREERDP_API BOOL freerdp_device_collection_del	(	rdpSettings *	settings,
		const RDPDR_DEVICE *	device
	)

Removed a device from the settings, returns ownership of the allocated device to caller.

Parameters

settings	the settings to remove the device from
device	the device to remove

Since: version 3.4.0

Returns: TRUE if the device was removed, FALSE if device was not found or is NULL

Definition at line 240 of file common/settings.c.

 {
   WINPR_ASSERT(settings);
  
   if (!device)
     return FALSE;
  
   const UINT32 count = settings->DeviceCount;
   for (size_t x = 0; x < count; x++)
   {
     const RDPDR_DEVICE* cur = settings->DeviceArray[x];
     if (cur == device)
     {
       for (size_t y = x + 1; y < count; y++)
       {
         RDPDR_DEVICE* next = settings->DeviceArray[y];
         settings->DeviceArray[y - 1] = next;
       }
       settings->DeviceArray[count - 1] = NULL;
       settings->DeviceCount--;
       return TRUE;
     }
   }
  
   return FALSE;
 }

◆ freerdp_rail_support_flags_to_string()

FREERDP_API const char* freerdp_rail_support_flags_to_string	(	UINT32	flags,
		char *	buffer,
		size_t	length
	)

Returns a stringified representation of RAIL support flags.

Parameters

flags	The flags to stringify
buffer	A pointer to the string buffer to write to
length	The size of the string buffer

Returns: A pointer to buffer for success, NULL otherwise

Definition at line 1955 of file common/settings.c.

 {
   const UINT32 mask =
       RAIL_LEVEL_SUPPORTED | RAIL_LEVEL_DOCKED_LANGBAR_SUPPORTED |
       RAIL_LEVEL_SHELL_INTEGRATION_SUPPORTED | RAIL_LEVEL_LANGUAGE_IME_SYNC_SUPPORTED |
       RAIL_LEVEL_SERVER_TO_CLIENT_IME_SYNC_SUPPORTED | RAIL_LEVEL_HIDE_MINIMIZED_APPS_SUPPORTED |
       RAIL_LEVEL_WINDOW_CLOAKING_SUPPORTED | RAIL_LEVEL_HANDSHAKE_EX_SUPPORTED;
  
   if (flags & RAIL_LEVEL_SUPPORTED)
     winpr_str_append("RAIL_LEVEL_SUPPORTED", buffer, length, "|");
   if (flags & RAIL_LEVEL_DOCKED_LANGBAR_SUPPORTED)
     winpr_str_append("RAIL_LEVEL_DOCKED_LANGBAR_SUPPORTED", buffer, length, "|");
   if (flags & RAIL_LEVEL_SHELL_INTEGRATION_SUPPORTED)
     winpr_str_append("RAIL_LEVEL_SHELL_INTEGRATION_SUPPORTED", buffer, length, "|");
   if (flags & RAIL_LEVEL_LANGUAGE_IME_SYNC_SUPPORTED)
     winpr_str_append("RAIL_LEVEL_LANGUAGE_IME_SYNC_SUPPORTED", buffer, length, "|");
   if (flags & RAIL_LEVEL_SERVER_TO_CLIENT_IME_SYNC_SUPPORTED)
     winpr_str_append("RAIL_LEVEL_SERVER_TO_CLIENT_IME_SYNC_SUPPORTED", buffer, length, "|");
   if (flags & RAIL_LEVEL_HIDE_MINIMIZED_APPS_SUPPORTED)
     winpr_str_append("RAIL_LEVEL_HIDE_MINIMIZED_APPS_SUPPORTED", buffer, length, "|");
   if (flags & RAIL_LEVEL_WINDOW_CLOAKING_SUPPORTED)
     winpr_str_append("RAIL_LEVEL_WINDOW_CLOAKING_SUPPORTED", buffer, length, "|");
   if (flags & RAIL_LEVEL_HANDSHAKE_EX_SUPPORTED)
     winpr_str_append("RAIL_LEVEL_HANDSHAKE_EX_SUPPORTED", buffer, length, "|");
   if (flags & RAIL_LEVEL_LANGUAGE_IME_SYNC_SUPPORTED)
     winpr_str_append("RAIL_LEVEL_LANGUAGE_IME_SYNC_SUPPORTED", buffer, length, "|");
   if ((flags & ~mask) != 0)
   {
     char tbuffer[64] = { 0 };
     (void)_snprintf(tbuffer, sizeof(tbuffer), "RAIL_FLAG_UNKNOWN 0x%08" PRIx32, flags & mask);
     winpr_str_append(tbuffer, buffer, length, "|");
   }
   return buffer;
 }

◆ freerdp_rdp_version_string()

FREERDP_API const char* freerdp_rdp_version_string ( UINT32 version )

Returns a stringified representation of the RDP protocol version.

Parameters

version The RDP protocol version number.

Returns: A string representation of the protocol version as "RDP_VERSION_10_11" or "RDP_VERSION_UNKNOWN" for invalid/unknown versions

Definition at line 2015 of file common/settings.c.

 {
   switch (version)
   {
     case RDP_VERSION_4:
       return "RDP_VERSION_4";
     case RDP_VERSION_5_PLUS:
       return "RDP_VERSION_5_PLUS";
     case RDP_VERSION_10_0:
       return "RDP_VERSION_10_0";
     case RDP_VERSION_10_1:
       return "RDP_VERSION_10_1";
     case RDP_VERSION_10_2:
       return "RDP_VERSION_10_2";
     case RDP_VERSION_10_3:
       return "RDP_VERSION_10_3";
     case RDP_VERSION_10_4:
       return "RDP_VERSION_10_4";
     case RDP_VERSION_10_5:
       return "RDP_VERSION_10_5";
     case RDP_VERSION_10_6:
       return "RDP_VERSION_10_6";
     case RDP_VERSION_10_7:
       return "RDP_VERSION_10_7";
     case RDP_VERSION_10_8:
       return "RDP_VERSION_10_8";
     case RDP_VERSION_10_9:
       return "RDP_VERSION_10_9";
     case RDP_VERSION_10_10:
       return "RDP_VERSION_10_10";
     case RDP_VERSION_10_11:
       return "RDP_VERSION_10_11";
     case RDP_VERSION_10_12:
       return "RDP_VERSION_10_12";
     default:
       return "RDP_VERSION_UNKNOWN";
   }
 }

◆ freerdp_rdpdr_dtyp_string()

FREERDP_API const char* freerdp_rdpdr_dtyp_string ( UINT32 type )

Returns a string representation of RDPDR_DTYP_*.

Parameters

type	The integer of the RDPDR_DTYP_* to stringify

Returns: A string representation of the RDPDR_DTYP_* or "RDPDR_DTYP_UNKNOWN"

Definition at line 2105 of file common/settings.c.

 {
   switch (type)
   {
     case RDPDR_DTYP_FILESYSTEM:
       return "RDPDR_DTYP_FILESYSTEM";
     case RDPDR_DTYP_PARALLEL:
       return "RDPDR_DTYP_PARALLEL";
     case RDPDR_DTYP_PRINT:
       return "RDPDR_DTYP_PRINT";
     case RDPDR_DTYP_SERIAL:
       return "RDPDR_DTYP_SERIAL";
     case RDPDR_DTYP_SMARTCARD:
       return "RDPDR_DTYP_SMARTCARD";
     default:
       return "RDPDR_DTYP_UNKNOWN";
   }
 }

◆ freerdp_set_gateway_usage_method()

FREERDP_API BOOL freerdp_set_gateway_usage_method	(	rdpSettings *	settings,
		UINT32	GatewayUsageMethod
	)

This corresponds to "Automatically detect RD Gateway server settings", which means the client attempts to use gateway group policy settings http://technet.microsoft.com/en-us/library/cc770601.aspx

Definition at line 1012 of file common/settings.c.

 {
   if (!freerdp_settings_set_uint32(settings, FreeRDP_GatewayUsageMethod, GatewayUsageMethod))
     return FALSE;
  
   if (GatewayUsageMethod == TSC_PROXY_MODE_NONE_DIRECT)
   {
     if (!freerdp_settings_set_bool(settings, FreeRDP_GatewayEnabled, FALSE) ||
         !freerdp_settings_set_bool(settings, FreeRDP_GatewayBypassLocal, FALSE))
       return FALSE;
   }
   else if (GatewayUsageMethod == TSC_PROXY_MODE_DIRECT)
   {
     if (!freerdp_settings_set_bool(settings, FreeRDP_GatewayEnabled, TRUE) ||
         !freerdp_settings_set_bool(settings, FreeRDP_GatewayBypassLocal, FALSE))
       return FALSE;
   }
   else if (GatewayUsageMethod == TSC_PROXY_MODE_DETECT)
   {
     if (!freerdp_settings_set_bool(settings, FreeRDP_GatewayEnabled, TRUE) ||
         !freerdp_settings_set_bool(settings, FreeRDP_GatewayBypassLocal, TRUE))
       return FALSE;
   }
   else if (GatewayUsageMethod == TSC_PROXY_MODE_DEFAULT)
   {
     if (!freerdp_settings_set_bool(settings, FreeRDP_GatewayEnabled, FALSE) ||
         !freerdp_settings_set_bool(settings, FreeRDP_GatewayBypassLocal, FALSE))
       return FALSE;
   }
   else if (GatewayUsageMethod == TSC_PROXY_MODE_NONE_DETECT)
   {
     if (!freerdp_settings_set_bool(settings, FreeRDP_GatewayEnabled, FALSE) ||
         !freerdp_settings_set_bool(settings, FreeRDP_GatewayBypassLocal, FALSE))
       return FALSE;
   }
  
   return TRUE;
 }

References freerdp_settings_set_uint32().

Here is the call graph for this function:

◆ freerdp_settings_append_string()

FREERDP_API BOOL freerdp_settings_append_string	(	rdpSettings *	settings,
		FreeRDP_Settings_Keys_String	id,
		const char *	separator,
		const char *	param
	)

appends a string to a settings value. The param is copied. If the initial value of the setting was not empty,

is created

Parameters

settings	A pointer to the settings to query, must not be NULL.
id	The key to query
separator	The separator string to use. May be NULL (no separator)
param	The value to append

Returns: TRUE for success, FALSE for failure

Definition at line 2196 of file common/settings.c.

 {
   const char* old = freerdp_settings_get_string(settings, id);
  
   size_t len = 0;
   char* str = NULL;
  
   if (!old)
     winpr_asprintf(&str, &len, "%s", param);
   else if (!separator)
     winpr_asprintf(&str, &len, "%s%s", old, param);
   else
     winpr_asprintf(&str, &len, "%s%s%s", old, separator, param);
  
   const BOOL rc = freerdp_settings_set_string_len(settings, id, str, len);
   free(str);
   return rc;
 }

References freerdp_settings_get_string(), and freerdp_settings_set_string_len().

Here is the call graph for this function:

◆ freerdp_settings_are_valid()

FREERDP_API BOOL freerdp_settings_are_valid ( const rdpSettings * settings )

Returns TRUE if settings are in a valid state, FALSE otherwise.

This function is meant to replace tideous return checks for freerdp_settings_set_* with a single check after these calls.

Parameters

settings the settings instance to check

Returns: TRUE if valid, FALSE otherwise

Definition at line 2216 of file common/settings.c.

 {
   return settings != NULL;
 }

◆ freerdp_settings_clone()

FREERDP_API rdpSettings* freerdp_settings_clone ( const rdpSettings * settings )

Creates a deep copy of settings.

Parameters

settings A pointer to a settings struct to copy. May be NULL (returns NULL)

Returns: A newly allocated copy of settings or NULL

Definition at line 1158 of file core/settings.c.

 {
   rdpSettings* _settings = (rdpSettings*)calloc(1, sizeof(rdpSettings));
  
   if (!freerdp_settings_copy(_settings, settings))
     goto out_fail;
  
   return _settings;
 out_fail:
   freerdp_settings_free(_settings);
   return NULL;
 }

References freerdp_settings_copy(), and freerdp_settings_free().

Here is the call graph for this function:

◆ freerdp_settings_copy()

FREERDP_API BOOL freerdp_settings_copy	(	rdpSettings *	dst,
		const rdpSettings *	src
	)

Deep copies settings from src to dst.

The function frees up all allocated data in dst before copying the data from src

Parameters

dst	A pointer for the settings to copy data to. May be NULL (fails copy)
src	A pointer to the settings to copy. May be NULL (fails copy)

Returns: TRUE for success, FALSE for failure.

Definition at line 1103 of file core/settings.c.

 {
   BOOL rc = 0;
  
   if (!settings || !_settings)
     return FALSE;
  
   /* This is required to free all non string buffers */
   freerdp_settings_free_internal(_settings);
   /* This copies everything except allocated non string buffers. reset all allocated buffers to
    * NULL to fix issues during cleanup */
   rc = freerdp_settings_clone_keys(_settings, settings);
  
   _settings->LoadBalanceInfo = NULL;
   _settings->ServerRandom = NULL;
   _settings->ClientRandom = NULL;
   _settings->ServerCertificate = NULL;
   _settings->RdpServerCertificate = NULL;
   _settings->RdpServerRsaKey = NULL;
   _settings->ChannelDefArray = NULL;
   _settings->MonitorDefArray = NULL;
   _settings->MonitorIds = NULL;
   _settings->OrderSupport = NULL;
   _settings->BitmapCacheV2CellInfo = NULL;
   _settings->GlyphCache = NULL;
   _settings->FragCache = NULL;
   _settings->ClientAutoReconnectCookie = NULL;
   _settings->ServerAutoReconnectCookie = NULL;
   _settings->ClientTimeZone = NULL;
   _settings->RedirectionPassword = NULL;
   _settings->RedirectionTsvUrl = NULL;
   _settings->TargetNetAddresses = NULL;
   _settings->TargetNetPorts = NULL;
   _settings->DeviceArray = NULL;
   _settings->StaticChannelArray = NULL;
   _settings->DynamicChannelArray = NULL;
   _settings->ReceivedCapabilities = NULL;
   _settings->ReceivedCapabilityData = NULL;
   _settings->ReceivedCapabilityDataSizes = NULL;
  
   _settings->ServerLicenseProductIssuersCount = 0;
   _settings->ServerLicenseProductIssuers = NULL;
  
   if (!rc)
     goto out_fail;
  
   /* Begin copying */
   if (!freerdp_settings_int_buffer_copy(_settings, settings))
     goto out_fail;
   return TRUE;
 out_fail:
   freerdp_settings_free_internal(_settings);
   return FALSE;
 }

Referenced by freerdp_settings_clone().

Here is the caller graph for this function:

◆ freerdp_settings_copy_item()

FREERDP_API BOOL freerdp_settings_copy_item	(	rdpSettings *	dst,
		const rdpSettings *	src,
		SSIZE_T	id
	)

copies one setting identified by id from src to dst

The function frees up all allocated data in dst before copying the data from src

Parameters

dst	A pointer for the settings to copy data to. May be NULL (fails copy)
src	A pointer to the settings to copy. May be NULL (fails copy)
id	The settings identifier to copy

Returns: TRUE for success, FALSE for failure.

Definition at line 421 of file settings_str.c.

 {
   WINPR_ASSERT(dst);
   WINPR_ASSERT(src);
  
   const SSIZE_T key = freerdp_settings_get_type_for_key(id);
   switch (key)
   {
     case FREERDP_SETTINGS_TYPE_BOOL:
     {
       const BOOL val = freerdp_settings_get_bool(src, (FreeRDP_Settings_Keys_Bool)id);
       return freerdp_settings_set_bool(dst, (FreeRDP_Settings_Keys_Bool)id, val);
     }
     case FREERDP_SETTINGS_TYPE_INT16:
     {
       const INT16 val = freerdp_settings_get_int16(src, (FreeRDP_Settings_Keys_Int16)id);
       return freerdp_settings_set_int16(dst, (FreeRDP_Settings_Keys_Int16)id, val);
     }
     case FREERDP_SETTINGS_TYPE_INT32:
     {
       const INT32 val = freerdp_settings_get_int32(src, (FreeRDP_Settings_Keys_Int32)id);
       return freerdp_settings_set_int32(dst, (FreeRDP_Settings_Keys_Int32)id, val);
     }
     case FREERDP_SETTINGS_TYPE_INT64:
     {
       const INT64 val = freerdp_settings_get_int64(src, (FreeRDP_Settings_Keys_Int64)id);
       return freerdp_settings_set_int64(dst, (FreeRDP_Settings_Keys_Int64)id, val);
     }
     case FREERDP_SETTINGS_TYPE_UINT16:
     {
       const UINT16 val = freerdp_settings_get_uint16(src, (FreeRDP_Settings_Keys_UInt16)id);
       return freerdp_settings_set_uint16(dst, (FreeRDP_Settings_Keys_UInt16)id, val);
     }
     case FREERDP_SETTINGS_TYPE_UINT32:
     {
       const UINT32 val = freerdp_settings_get_uint32(src, (FreeRDP_Settings_Keys_UInt32)id);
       return freerdp_settings_set_uint32(dst, (FreeRDP_Settings_Keys_UInt32)id, val);
     }
     case FREERDP_SETTINGS_TYPE_UINT64:
     {
       const UINT64 val = freerdp_settings_get_uint64(src, (FreeRDP_Settings_Keys_UInt64)id);
       return freerdp_settings_set_uint64(dst, (FreeRDP_Settings_Keys_UInt64)id, val);
     }
     case FREERDP_SETTINGS_TYPE_STRING:
     {
       const char* val = freerdp_settings_get_string(src, (FreeRDP_Settings_Keys_String)id);
       return freerdp_settings_set_string(dst, (FreeRDP_Settings_Keys_String)id, val);
     }
     case FREERDP_SETTINGS_TYPE_POINTER:
     {
       const void* val = freerdp_settings_get_pointer(src, (FreeRDP_Settings_Keys_Pointer)id);
       return freerdp_settings_set_pointer(dst, (FreeRDP_Settings_Keys_Pointer)id, val);
     }
     default:
       return FALSE;
   }
 }

Here is the call graph for this function:

◆ freerdp_settings_dump()

FREERDP_API void freerdp_settings_dump	(	wLog *	log,
		DWORD	level,
		const rdpSettings *	settings
	)

Dumps the contents of a settings struct to a WLog logger.

Parameters

log	The logger to write to, must not be NULL
level	The WLog level to use for the log entries
settings	A pointer to the settings to dump. May be NULL.

Definition at line 242 of file settings_str.c.

 {
   WINPR_ASSERT(log);
   WINPR_ASSERT(settings);
  
   for (size_t x = 0; x < ARRAYSIZE(settings_map); x++)
   {
     const struct settings_str_entry* cur = &settings_map[x];
     switch (cur->type)
     {
       case FREERDP_SETTINGS_TYPE_BOOL: /* bool */
       {
         BOOL sval =
             freerdp_settings_get_bool(settings, (FreeRDP_Settings_Keys_Bool)cur->id);
         WLog_Print(log, level, "%s [BOOL]: %s", cur->str, sval ? "TRUE" : "FALSE");
       }
       break;
       case FREERDP_SETTINGS_TYPE_UINT16: /* UINT16 */
       {
         UINT16 sval =
             freerdp_settings_get_uint16(settings, (FreeRDP_Settings_Keys_UInt16)cur->id);
         WLog_Print(log, level, "%s [UINT16]: %" PRIu16, cur->str, sval);
       }
       break;
       case FREERDP_SETTINGS_TYPE_INT16: /* INT16 */
       {
         INT16 sval =
             freerdp_settings_get_int16(settings, (FreeRDP_Settings_Keys_Int16)cur->id);
         WLog_Print(log, level, "%s [INT16]: %" PRId16, cur->str, sval);
       }
       break;
       case FREERDP_SETTINGS_TYPE_UINT32: /* UINT32 */
       {
         UINT32 sval =
             freerdp_settings_get_uint32(settings, (FreeRDP_Settings_Keys_UInt32)cur->id);
         WLog_Print(log, level, "%s [UINT32]: %" PRIu32, cur->str, sval);
       }
       break;
       case FREERDP_SETTINGS_TYPE_INT32: /* INT32 */
       {
         INT32 sval =
             freerdp_settings_get_int32(settings, (FreeRDP_Settings_Keys_Int32)cur->id);
         WLog_Print(log, level, "%s [INT32]: %" PRId32, cur->str, sval);
       }
       break;
       case FREERDP_SETTINGS_TYPE_UINT64: /* UINT64 */
       {
         UINT64 sval =
             freerdp_settings_get_uint64(settings, (FreeRDP_Settings_Keys_UInt64)cur->id);
         WLog_Print(log, level, "%s [UINT64]: %" PRIu64, cur->str, sval);
       }
       break;
       case FREERDP_SETTINGS_TYPE_INT64: /* INT64 */
       {
         INT64 sval =
             freerdp_settings_get_int64(settings, (FreeRDP_Settings_Keys_Int64)cur->id);
         WLog_Print(log, level, "%s [INT64]: %" PRId64, cur->str, sval);
       }
       break;
       case FREERDP_SETTINGS_TYPE_STRING: /* strings */
       {
         const char* sval =
             freerdp_settings_get_string(settings, (FreeRDP_Settings_Keys_String)cur->id);
         WLog_Print(log, level, "%s [STRING]: '%s'", cur->str, sval);
       }
       break;
       case FREERDP_SETTINGS_TYPE_POINTER: /* pointer */
       {
         const void* sval =
             freerdp_settings_get_pointer(settings, (FreeRDP_Settings_Keys_Pointer)cur->id);
         WLog_Print(log, level, "%s [POINTER]: '%p'", cur->str, sval);
       }
       break;
     }
   }
 }

References freerdp_settings_get_bool(), freerdp_settings_get_int16(), freerdp_settings_get_int32(), freerdp_settings_get_int64(), freerdp_settings_get_pointer(), freerdp_settings_get_string(), freerdp_settings_get_uint16(), freerdp_settings_get_uint32(), and freerdp_settings_get_uint64().

Here is the call graph for this function:

◆ freerdp_settings_free()

FREERDP_API void freerdp_settings_free ( rdpSettings * settings )

Free a settings struct with all data in it.

Parameters

settings A pointer to the settings to free, May be NULL

Definition at line 854 of file core/settings.c.

 {
   if (!settings)
     return;
  
   freerdp_settings_free_internal(settings);
   free(settings);
 }

Referenced by freerdp_settings_clone().

Here is the caller graph for this function:

◆ freerdp_settings_get_bool()

FREERDP_API BOOL freerdp_settings_get_bool	(	const rdpSettings *	settings,
		FreeRDP_Settings_Keys_Bool	id
	)

Returns a boolean settings value.

Parameters

settings	A pointer to the settings to query, must not be NULL.
id	The key to query

Returns: the value of the boolean key

Definition at line 54 of file settings_getters.c.

 {
   WINPR_ASSERT(settings);
  
   switch (id)
   {
     case FreeRDP_AadSecurity:
       return settings->AadSecurity;
  
     case FreeRDP_AllowCacheWaitingList:
       return settings->AllowCacheWaitingList;
  
     case FreeRDP_AllowDesktopComposition:
       return settings->AllowDesktopComposition;
  
     case FreeRDP_AllowFontSmoothing:
       return settings->AllowFontSmoothing;
  
     case FreeRDP_AllowUnanouncedOrdersFromServer:
       return settings->AllowUnanouncedOrdersFromServer;
  
     case FreeRDP_AltSecFrameMarkerSupport:
       return settings->AltSecFrameMarkerSupport;
  
     case FreeRDP_AsyncChannels:
       return settings->AsyncChannels;
  
     case FreeRDP_AsyncUpdate:
       return settings->AsyncUpdate;
  
     case FreeRDP_AudioCapture:
       return settings->AudioCapture;
  
     case FreeRDP_AudioPlayback:
       return settings->AudioPlayback;
  
     case FreeRDP_Authentication:
       return settings->Authentication;
  
     case FreeRDP_AuthenticationOnly:
       return settings->AuthenticationOnly;
  
     case FreeRDP_AutoAcceptCertificate:
       return settings->AutoAcceptCertificate;
  
     case FreeRDP_AutoDenyCertificate:
       return settings->AutoDenyCertificate;
  
     case FreeRDP_AutoLogonEnabled:
       return settings->AutoLogonEnabled;
  
     case FreeRDP_AutoReconnectionEnabled:
       return settings->AutoReconnectionEnabled;
  
     case FreeRDP_AutoReconnectionPacketSupported:
       return settings->AutoReconnectionPacketSupported;
  
     case FreeRDP_BitmapCacheEnabled:
       return settings->BitmapCacheEnabled;
  
     case FreeRDP_BitmapCachePersistEnabled:
       return settings->BitmapCachePersistEnabled;
  
     case FreeRDP_BitmapCacheV3Enabled:
       return settings->BitmapCacheV3Enabled;
  
     case FreeRDP_BitmapCompressionDisabled:
       return settings->BitmapCompressionDisabled;
  
     case FreeRDP_CertificateCallbackPreferPEM:
       return settings->CertificateCallbackPreferPEM;
  
     case FreeRDP_CompressionEnabled:
       return settings->CompressionEnabled;
  
     case FreeRDP_ConnectChildSession:
       return settings->ConnectChildSession;
  
     case FreeRDP_ConsoleSession:
       return settings->ConsoleSession;
  
     case FreeRDP_CredentialsFromStdin:
       return settings->CredentialsFromStdin;
  
     case FreeRDP_DeactivateClientDecoding:
       return settings->DeactivateClientDecoding;
  
     case FreeRDP_Decorations:
       return settings->Decorations;
  
     case FreeRDP_DesktopResize:
       return settings->DesktopResize;
  
     case FreeRDP_DeviceRedirection:
       return settings->DeviceRedirection;
  
     case FreeRDP_DisableCredentialsDelegation:
       return settings->DisableCredentialsDelegation;
  
     case FreeRDP_DisableCtrlAltDel:
       return settings->DisableCtrlAltDel;
  
     case FreeRDP_DisableCursorBlinking:
       return settings->DisableCursorBlinking;
  
     case FreeRDP_DisableCursorShadow:
       return settings->DisableCursorShadow;
  
     case FreeRDP_DisableFullWindowDrag:
       return settings->DisableFullWindowDrag;
  
     case FreeRDP_DisableMenuAnims:
       return settings->DisableMenuAnims;
  
     case FreeRDP_DisableRemoteAppCapsCheck:
       return settings->DisableRemoteAppCapsCheck;
  
     case FreeRDP_DisableThemes:
       return settings->DisableThemes;
  
     case FreeRDP_DisableWallpaper:
       return settings->DisableWallpaper;
  
     case FreeRDP_DrawAllowColorSubsampling:
       return settings->DrawAllowColorSubsampling;
  
     case FreeRDP_DrawAllowDynamicColorFidelity:
       return settings->DrawAllowDynamicColorFidelity;
  
     case FreeRDP_DrawAllowSkipAlpha:
       return settings->DrawAllowSkipAlpha;
  
     case FreeRDP_DrawGdiPlusCacheEnabled:
       return settings->DrawGdiPlusCacheEnabled;
  
     case FreeRDP_DrawGdiPlusEnabled:
       return settings->DrawGdiPlusEnabled;
  
     case FreeRDP_DrawNineGridEnabled:
       return settings->DrawNineGridEnabled;
  
     case FreeRDP_DumpRemoteFx:
       return settings->DumpRemoteFx;
  
     case FreeRDP_DynamicDaylightTimeDisabled:
       return settings->DynamicDaylightTimeDisabled;
  
     case FreeRDP_DynamicResolutionUpdate:
       return settings->DynamicResolutionUpdate;
  
     case FreeRDP_EmbeddedWindow:
       return settings->EmbeddedWindow;
  
     case FreeRDP_EnableWindowsKey:
       return settings->EnableWindowsKey;
  
     case FreeRDP_EncomspVirtualChannel:
       return settings->EncomspVirtualChannel;
  
     case FreeRDP_ExtSecurity:
       return settings->ExtSecurity;
  
     case FreeRDP_ExternalCertificateManagement:
       return settings->ExternalCertificateManagement;
  
     case FreeRDP_FIPSMode:
       return settings->FIPSMode;
  
     case FreeRDP_FastPathInput:
       return settings->FastPathInput;
  
     case FreeRDP_FastPathOutput:
       return settings->FastPathOutput;
  
     case FreeRDP_ForceEncryptedCsPdu:
       return settings->ForceEncryptedCsPdu;
  
     case FreeRDP_ForceMultimon:
       return settings->ForceMultimon;
  
     case FreeRDP_FrameMarkerCommandEnabled:
       return settings->FrameMarkerCommandEnabled;
  
     case FreeRDP_Fullscreen:
       return settings->Fullscreen;
  
     case FreeRDP_GatewayArmTransport:
       return settings->GatewayArmTransport;
  
     case FreeRDP_GatewayBypassLocal:
       return settings->GatewayBypassLocal;
  
     case FreeRDP_GatewayEnabled:
       return settings->GatewayEnabled;
  
     case FreeRDP_GatewayHttpExtAuthSspiNtlm:
       return settings->GatewayHttpExtAuthSspiNtlm;
  
     case FreeRDP_GatewayHttpTransport:
       return settings->GatewayHttpTransport;
  
     case FreeRDP_GatewayHttpUseWebsockets:
       return settings->GatewayHttpUseWebsockets;
  
     case FreeRDP_GatewayIgnoreRedirectionPolicy:
       return settings->GatewayIgnoreRedirectionPolicy;
  
     case FreeRDP_GatewayRpcTransport:
       return settings->GatewayRpcTransport;
  
     case FreeRDP_GatewayUdpTransport:
       return settings->GatewayUdpTransport;
  
     case FreeRDP_GatewayUseSameCredentials:
       return settings->GatewayUseSameCredentials;
  
     case FreeRDP_GfxAVC444:
       return settings->GfxAVC444;
  
     case FreeRDP_GfxAVC444v2:
       return settings->GfxAVC444v2;
  
     case FreeRDP_GfxH264:
       return settings->GfxH264;
  
     case FreeRDP_GfxPlanar:
       return settings->GfxPlanar;
  
     case FreeRDP_GfxProgressive:
       return settings->GfxProgressive;
  
     case FreeRDP_GfxProgressiveV2:
       return settings->GfxProgressiveV2;
  
     case FreeRDP_GfxSendQoeAck:
       return settings->GfxSendQoeAck;
  
     case FreeRDP_GfxSmallCache:
       return settings->GfxSmallCache;
  
     case FreeRDP_GfxSuspendFrameAck:
       return settings->GfxSuspendFrameAck;
  
     case FreeRDP_GfxThinClient:
       return settings->GfxThinClient;
  
     case FreeRDP_GrabKeyboard:
       return settings->GrabKeyboard;
  
     case FreeRDP_GrabMouse:
       return settings->GrabMouse;
  
     case FreeRDP_HasExtendedMouseEvent:
       return settings->HasExtendedMouseEvent;
  
     case FreeRDP_HasHorizontalWheel:
       return settings->HasHorizontalWheel;
  
     case FreeRDP_HasMonitorAttributes:
       return settings->HasMonitorAttributes;
  
     case FreeRDP_HasQoeEvent:
       return settings->HasQoeEvent;
  
     case FreeRDP_HasRelativeMouseEvent:
       return settings->HasRelativeMouseEvent;
  
     case FreeRDP_HiDefRemoteApp:
       return settings->HiDefRemoteApp;
  
     case FreeRDP_IPv6Enabled:
       return settings->IPv6Enabled;
  
     case FreeRDP_IgnoreCertificate:
       return settings->IgnoreCertificate;
  
     case FreeRDP_IgnoreInvalidDevices:
       return settings->IgnoreInvalidDevices;
  
     case FreeRDP_JpegCodec:
       return settings->JpegCodec;
  
     case FreeRDP_KerberosRdgIsProxy:
       return settings->KerberosRdgIsProxy;
  
     case FreeRDP_ListMonitors:
       return settings->ListMonitors;
  
     case FreeRDP_LocalConnection:
       return settings->LocalConnection;
  
     case FreeRDP_LogonErrors:
       return settings->LogonErrors;
  
     case FreeRDP_LogonNotify:
       return settings->LogonNotify;
  
     case FreeRDP_LongCredentialsSupported:
       return settings->LongCredentialsSupported;
  
     case FreeRDP_LyncRdpMode:
       return settings->LyncRdpMode;
  
     case FreeRDP_MaximizeShell:
       return settings->MaximizeShell;
  
     case FreeRDP_MouseAttached:
       return settings->MouseAttached;
  
     case FreeRDP_MouseHasWheel:
       return settings->MouseHasWheel;
  
     case FreeRDP_MouseMotion:
       return settings->MouseMotion;
  
     case FreeRDP_MouseUseRelativeMove:
       return settings->MouseUseRelativeMove;
  
     case FreeRDP_MstscCookieMode:
       return settings->MstscCookieMode;
  
     case FreeRDP_MultiTouchGestures:
       return settings->MultiTouchGestures;
  
     case FreeRDP_MultiTouchInput:
       return settings->MultiTouchInput;
  
     case FreeRDP_NSCodec:
       return settings->NSCodec;
  
     case FreeRDP_NSCodecAllowDynamicColorFidelity:
       return settings->NSCodecAllowDynamicColorFidelity;
  
     case FreeRDP_NSCodecAllowSubsampling:
       return settings->NSCodecAllowSubsampling;
  
     case FreeRDP_NegotiateSecurityLayer:
       return settings->NegotiateSecurityLayer;
  
     case FreeRDP_NetworkAutoDetect:
       return settings->NetworkAutoDetect;
  
     case FreeRDP_NlaSecurity:
       return settings->NlaSecurity;
  
     case FreeRDP_NoBitmapCompressionHeader:
       return settings->NoBitmapCompressionHeader;
  
     case FreeRDP_OldLicenseBehaviour:
       return settings->OldLicenseBehaviour;
  
     case FreeRDP_PasswordIsSmartcardPin:
       return settings->PasswordIsSmartcardPin;
  
     case FreeRDP_PercentScreenUseHeight:
       return settings->PercentScreenUseHeight;
  
     case FreeRDP_PercentScreenUseWidth:
       return settings->PercentScreenUseWidth;
  
     case FreeRDP_PlayRemoteFx:
       return settings->PlayRemoteFx;
  
     case FreeRDP_PreferIPv6OverIPv4:
       return settings->PreferIPv6OverIPv4;
  
     case FreeRDP_PrintReconnectCookie:
       return settings->PrintReconnectCookie;
  
     case FreeRDP_PromptForCredentials:
       return settings->PromptForCredentials;
  
     case FreeRDP_RdpSecurity:
       return settings->RdpSecurity;
  
     case FreeRDP_RdstlsSecurity:
       return settings->RdstlsSecurity;
  
     case FreeRDP_RedirectClipboard:
       return settings->RedirectClipboard;
  
     case FreeRDP_RedirectDrives:
       return settings->RedirectDrives;
  
     case FreeRDP_RedirectHomeDrive:
       return settings->RedirectHomeDrive;
  
     case FreeRDP_RedirectParallelPorts:
       return settings->RedirectParallelPorts;
  
     case FreeRDP_RedirectPrinters:
       return settings->RedirectPrinters;
  
     case FreeRDP_RedirectSerialPorts:
       return settings->RedirectSerialPorts;
  
     case FreeRDP_RedirectSmartCards:
       return settings->RedirectSmartCards;
  
     case FreeRDP_RedirectWebAuthN:
       return settings->RedirectWebAuthN;
  
     case FreeRDP_RefreshRect:
       return settings->RefreshRect;
  
     case FreeRDP_RemdeskVirtualChannel:
       return settings->RemdeskVirtualChannel;
  
     case FreeRDP_RemoteAppLanguageBarSupported:
       return settings->RemoteAppLanguageBarSupported;
  
     case FreeRDP_RemoteApplicationMode:
       return settings->RemoteApplicationMode;
  
     case FreeRDP_RemoteAssistanceMode:
       return settings->RemoteAssistanceMode;
  
     case FreeRDP_RemoteAssistanceRequestControl:
       return settings->RemoteAssistanceRequestControl;
  
     case FreeRDP_RemoteConsoleAudio:
       return settings->RemoteConsoleAudio;
  
     case FreeRDP_RemoteCredentialGuard:
       return settings->RemoteCredentialGuard;
  
     case FreeRDP_RemoteFxCodec:
       return settings->RemoteFxCodec;
  
     case FreeRDP_RemoteFxImageCodec:
       return settings->RemoteFxImageCodec;
  
     case FreeRDP_RemoteFxOnly:
       return settings->RemoteFxOnly;
  
     case FreeRDP_RestrictedAdminModeRequired:
       return settings->RestrictedAdminModeRequired;
  
     case FreeRDP_SaltedChecksum:
       return settings->SaltedChecksum;
  
     case FreeRDP_SendPreconnectionPdu:
       return settings->SendPreconnectionPdu;
  
     case FreeRDP_ServerLicenseRequired:
       return settings->ServerLicenseRequired;
  
     case FreeRDP_ServerMode:
       return settings->ServerMode;
  
     case FreeRDP_SmartSizing:
       return settings->SmartSizing;
  
     case FreeRDP_SmartcardEmulation:
       return settings->SmartcardEmulation;
  
     case FreeRDP_SmartcardLogon:
       return settings->SmartcardLogon;
  
     case FreeRDP_SoftwareGdi:
       return settings->SoftwareGdi;
  
     case FreeRDP_SoundBeepsEnabled:
       return settings->SoundBeepsEnabled;
  
     case FreeRDP_SpanMonitors:
       return settings->SpanMonitors;
  
     case FreeRDP_SupportAsymetricKeys:
       return settings->SupportAsymetricKeys;
  
     case FreeRDP_SupportDisplayControl:
       return settings->SupportDisplayControl;
  
     case FreeRDP_SupportDynamicChannels:
       return settings->SupportDynamicChannels;
  
     case FreeRDP_SupportDynamicTimeZone:
       return settings->SupportDynamicTimeZone;
  
     case FreeRDP_SupportEchoChannel:
       return settings->SupportEchoChannel;
  
     case FreeRDP_SupportEdgeActionV1:
       return settings->SupportEdgeActionV1;
  
     case FreeRDP_SupportEdgeActionV2:
       return settings->SupportEdgeActionV2;
  
     case FreeRDP_SupportErrorInfoPdu:
       return settings->SupportErrorInfoPdu;
  
     case FreeRDP_SupportGeometryTracking:
       return settings->SupportGeometryTracking;
  
     case FreeRDP_SupportGraphicsPipeline:
       return settings->SupportGraphicsPipeline;
  
     case FreeRDP_SupportHeartbeatPdu:
       return settings->SupportHeartbeatPdu;
  
     case FreeRDP_SupportMonitorLayoutPdu:
       return settings->SupportMonitorLayoutPdu;
  
     case FreeRDP_SupportMultitransport:
       return settings->SupportMultitransport;
  
     case FreeRDP_SupportSSHAgentChannel:
       return settings->SupportSSHAgentChannel;
  
     case FreeRDP_SupportSkipChannelJoin:
       return settings->SupportSkipChannelJoin;
  
     case FreeRDP_SupportStatusInfoPdu:
       return settings->SupportStatusInfoPdu;
  
     case FreeRDP_SupportVideoOptimized:
       return settings->SupportVideoOptimized;
  
     case FreeRDP_SuppressOutput:
       return settings->SuppressOutput;
  
     case FreeRDP_SurfaceCommandsEnabled:
       return settings->SurfaceCommandsEnabled;
  
     case FreeRDP_SurfaceFrameMarkerEnabled:
       return settings->SurfaceFrameMarkerEnabled;
  
     case FreeRDP_SuspendInput:
       return settings->SuspendInput;
  
     case FreeRDP_SynchronousDynamicChannels:
       return settings->SynchronousDynamicChannels;
  
     case FreeRDP_SynchronousStaticChannels:
       return settings->SynchronousStaticChannels;
  
     case FreeRDP_TcpKeepAlive:
       return settings->TcpKeepAlive;
  
     case FreeRDP_TlsSecurity:
       return settings->TlsSecurity;
  
     case FreeRDP_ToggleFullscreen:
       return settings->ToggleFullscreen;
  
     case FreeRDP_TransportDump:
       return settings->TransportDump;
  
     case FreeRDP_TransportDumpReplay:
       return settings->TransportDumpReplay;
  
     case FreeRDP_TransportDumpReplayNodelay:
       return settings->TransportDumpReplayNodelay;
  
     case FreeRDP_UnicodeInput:
       return settings->UnicodeInput;
  
     case FreeRDP_UnmapButtons:
       return settings->UnmapButtons;
  
     case FreeRDP_UseCommonStdioCallbacks:
       return settings->UseCommonStdioCallbacks;
  
     case FreeRDP_UseMultimon:
       return settings->UseMultimon;
  
     case FreeRDP_UseRdpSecurityLayer:
       return settings->UseRdpSecurityLayer;
  
     case FreeRDP_UsingSavedCredentials:
       return settings->UsingSavedCredentials;
  
     case FreeRDP_VideoDisable:
       return settings->VideoDisable;
  
     case FreeRDP_VmConnectMode:
       return settings->VmConnectMode;
  
     case FreeRDP_WaitForOutputBufferFlush:
       return settings->WaitForOutputBufferFlush;
  
     case FreeRDP_Workarea:
       return settings->Workarea;
  
     default:
       WLog_ERR(TAG, "Invalid key index %" PRIuz " [%s|%s]", id,
                freerdp_settings_get_name_for_key(id),
                freerdp_settings_get_type_name_for_key(id));
       WINPR_ASSERT(FALSE);
       return FALSE;
   }
 }

References freerdp_settings_get_name_for_key(), and freerdp_settings_get_type_name_for_key().

Referenced by freerdp_settings_copy_item(), freerdp_settings_dump(), freerdp_settings_print_diff(), and AppDelegate::rdpConnectError:.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ freerdp_settings_get_codecs_flags()

FREERDP_API UINT32 freerdp_settings_get_codecs_flags ( const rdpSettings * settings )

helper function to get a mask of supported codec flags.

This function checks various settings to create a mask of supported codecs FreeRDP_CodecFlags defines the codecs

Parameters

settings the settings to check

Returns: a mask of supported codecs

Definition at line 1809 of file common/settings.c.

 {
   UINT32 flags = FREERDP_CODEC_ALL;
   if (settings->RemoteFxCodec == FALSE)
   {
     flags &= ~FREERDP_CODEC_REMOTEFX;
   }
   if (settings->NSCodec == FALSE)
   {
     flags &= ~FREERDP_CODEC_NSCODEC;
   }
   /*TODO: check other codecs flags */
   return flags;
 }

◆ freerdp_settings_get_config_path()

FREERDP_API char* freerdp_settings_get_config_path ( void )

return the configuration directory for the library

Returns: The current configuration path or NULL

Since: version 3.6.0

Definition at line 365 of file core/settings.c.

 {
   char* path = NULL;
   /* For default FreeRDP continue using same config directory
    * as in old releases.
    * Custom builds use <Vendor>/<Product> as config folder. */
 #if !defined(WITH_FULL_CONFIG_PATH)
   if (_stricmp(FREERDP_VENDOR_STRING, FREERDP_PRODUCT_STRING) == 0)
     return freerdp_settings_get_legacy_config_path();
 #endif
  
   char* base = GetKnownSubPath(KNOWN_PATH_XDG_CONFIG_HOME, FREERDP_VENDOR_STRING);
   if (base)
     path = GetCombinedPath(base, FREERDP_PRODUCT_STRING);
   free(base);
  
   return path;
 }

◆ freerdp_settings_get_int16()

FREERDP_API INT16 freerdp_settings_get_int16	(	const rdpSettings *	settings,
		FreeRDP_Settings_Keys_Int16	id
	)

Returns a INT16 settings value.

Parameters

settings	A pointer to the settings to query, must not be NULL.
id	The key to query

Returns: the value of the INT16 key

Definition at line 1574 of file settings_getters.c.

 {
   WINPR_ASSERT(settings);
  
   switch (id)
   {
     default:
       WLog_ERR(TAG, "Invalid key index %" PRIuz " [%s|%s]", id,
                freerdp_settings_get_name_for_key(id),
                freerdp_settings_get_type_name_for_key(id));
       WINPR_ASSERT(FALSE);
       return 0;
   }
 }

References freerdp_settings_get_name_for_key(), and freerdp_settings_get_type_name_for_key().

Referenced by freerdp_settings_copy_item(), freerdp_settings_dump(), and freerdp_settings_print_diff().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ freerdp_settings_get_int32()

FREERDP_API INT32 freerdp_settings_get_int32	(	const rdpSettings *	settings,
		FreeRDP_Settings_Keys_Int32	id
	)

Returns a INT32 settings value.

Parameters

settings	A pointer to the settings to query, must not be NULL.
id	The key to query

Returns: the value of the INT32 key

Definition at line 2534 of file settings_getters.c.

 {
   WINPR_ASSERT(settings);
  
   switch (id)
   {
     case FreeRDP_XPan:
       return settings->XPan;
  
     case FreeRDP_YPan:
       return settings->YPan;
  
     default:
       WLog_ERR(TAG, "Invalid key index %" PRIuz " [%s|%s]", id,
                freerdp_settings_get_name_for_key(id),
                freerdp_settings_get_type_name_for_key(id));
       WINPR_ASSERT(FALSE);
       return 0;
   }
 }

References freerdp_settings_get_name_for_key(), and freerdp_settings_get_type_name_for_key().

Referenced by freerdp_settings_copy_item(), freerdp_settings_dump(), and freerdp_settings_print_diff().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ freerdp_settings_get_int64()

FREERDP_API INT64 freerdp_settings_get_int64	(	const rdpSettings *	settings,
		FreeRDP_Settings_Keys_Int64	id
	)

Returns a INT64 settings value.

Parameters

settings	A pointer to the settings to query, must not be NULL.
id	The key to query

Returns: the value of the INT64 key

Definition at line 2633 of file settings_getters.c.

 {
   WINPR_ASSERT(settings);
  
   switch (id)
   {
     default:
       WLog_ERR(TAG, "Invalid key index %" PRIuz " [%s|%s]", id,
                freerdp_settings_get_name_for_key(id),
                freerdp_settings_get_type_name_for_key(id));
       WINPR_ASSERT(FALSE);
       return 0;
   }
 }

References freerdp_settings_get_name_for_key(), and freerdp_settings_get_type_name_for_key().

Referenced by freerdp_settings_copy_item(), freerdp_settings_dump(), and freerdp_settings_print_diff().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ freerdp_settings_get_key_for_name()

FREERDP_API SSIZE_T freerdp_settings_get_key_for_name ( const char * value )

Get a key index for the name string of that key.

Parameters

value A key name string like FreeRDP_ServerMode

Returns: The key index or -1 in case of an error (e.g. name does not exist)

Definition at line 340 of file settings_str.c.

 {
   WINPR_ASSERT(value);
  
   for (size_t x = 0; x < ARRAYSIZE(settings_map); x++)
   {
     const struct settings_str_entry* cur = &settings_map[x];
     if (strcmp(value, cur->str) == 0)
       return cur->id;
   }
   return -1;
 }

◆ freerdp_settings_get_name_for_key()

FREERDP_API const char* freerdp_settings_get_name_for_key ( SSIZE_T key )

Returns the type name for a key.

Parameters

key	the key number to stringify

Returns: the name of the key or NULL

Definition at line 410 of file settings_str.c.

 {
   for (size_t x = 0; x < ARRAYSIZE(settings_map); x++)
   {
     const struct settings_str_entry* cur = &settings_map[x];
     if (cur->id == key)
       return cur->str;
   }
   return NULL;
 }

Here is the caller graph for this function:

◆ freerdp_settings_get_pointer()

FREERDP_API const void* freerdp_settings_get_pointer	(	const rdpSettings *	settings,
		FreeRDP_Settings_Keys_Pointer	id
	)

Returns a immutable pointer settings value.

Parameters

settings	A pointer to the settings to query, must not be NULL.
id	The key to query

Returns: the immutable pointer value

Definition at line 1293 of file common/settings.c.

 {
   union
   {
     const rdpSettings* pc;
     rdpSettings* p;
   } cnv;
   cnv.pc = settings;
   return freerdp_settings_get_pointer_writable(cnv.p, id);
 }

References freerdp_settings_get_pointer_writable().

Referenced by freerdp_settings_copy_item(), freerdp_settings_dump(), and freerdp_settings_print_diff().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ freerdp_settings_get_pointer_writable()

FREERDP_API void* freerdp_settings_get_pointer_writable	(	rdpSettings *	settings,
		FreeRDP_Settings_Keys_Pointer	id
	)

Returns a mutable pointer settings value.

Parameters

settings	A pointer to the settings to query, must not be NULL.
id	The key to query

Returns: the mutable pointer value

Definition at line 3949 of file settings_getters.c.

 {
   WINPR_ASSERT(settings);
  
   switch (id)
   {
     case FreeRDP_BitmapCacheV2CellInfo:
       return settings->BitmapCacheV2CellInfo;
  
     case FreeRDP_ChannelDefArray:
       return settings->ChannelDefArray;
  
     case FreeRDP_ClientAutoReconnectCookie:
       return settings->ClientAutoReconnectCookie;
  
     case FreeRDP_ClientRandom:
       return settings->ClientRandom;
  
     case FreeRDP_ClientTimeZone:
       return settings->ClientTimeZone;
  
     case FreeRDP_DeviceArray:
       return settings->DeviceArray;
  
     case FreeRDP_DynamicChannelArray:
       return settings->DynamicChannelArray;
  
     case FreeRDP_FragCache:
       return settings->FragCache;
  
     case FreeRDP_GlyphCache:
       return settings->GlyphCache;
  
     case FreeRDP_LoadBalanceInfo:
       return settings->LoadBalanceInfo;
  
     case FreeRDP_MonitorDefArray:
       return settings->MonitorDefArray;
  
     case FreeRDP_MonitorIds:
       return settings->MonitorIds;
  
     case FreeRDP_OrderSupport:
       return settings->OrderSupport;
  
     case FreeRDP_Password51:
       return settings->Password51;
  
     case FreeRDP_RdpServerCertificate:
       return settings->RdpServerCertificate;
  
     case FreeRDP_RdpServerRsaKey:
       return settings->RdpServerRsaKey;
  
     case FreeRDP_ReceivedCapabilities:
       return settings->ReceivedCapabilities;
  
     case FreeRDP_ReceivedCapabilityData:
       return settings->ReceivedCapabilityData;
  
     case FreeRDP_ReceivedCapabilityDataSizes:
       return settings->ReceivedCapabilityDataSizes;
  
     case FreeRDP_RedirectionGuid:
       return settings->RedirectionGuid;
  
     case FreeRDP_RedirectionPassword:
       return settings->RedirectionPassword;
  
     case FreeRDP_RedirectionTargetCertificate:
       return settings->RedirectionTargetCertificate;
  
     case FreeRDP_RedirectionTsvUrl:
       return settings->RedirectionTsvUrl;
  
     case FreeRDP_ServerAutoReconnectCookie:
       return settings->ServerAutoReconnectCookie;
  
     case FreeRDP_ServerCertificate:
       return settings->ServerCertificate;
  
     case FreeRDP_ServerLicenseProductIssuers:
       return settings->ServerLicenseProductIssuers;
  
     case FreeRDP_ServerRandom:
       return settings->ServerRandom;
  
     case FreeRDP_StaticChannelArray:
       return settings->StaticChannelArray;
  
     case FreeRDP_TargetNetAddresses:
       return settings->TargetNetAddresses;
  
     case FreeRDP_TargetNetPorts:
       return settings->TargetNetPorts;
  
     case FreeRDP_instance:
       return settings->instance;
  
     default:
       WLog_ERR(TAG, "Invalid key index %" PRIuz " [%s|%s]", id,
                freerdp_settings_get_name_for_key(id),
                freerdp_settings_get_type_name_for_key(id));
       WINPR_ASSERT(FALSE);
       return NULL;
   }
 }

References freerdp_settings_get_name_for_key(), and freerdp_settings_get_type_name_for_key().

Referenced by freerdp_settings_get_pointer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ freerdp_settings_get_server_name()

FREERDP_API const char* freerdp_settings_get_server_name ( const rdpSettings * settings )

A helper function to return the correct server name.

The server name might be in key FreeRDP_ServerHostname or if used in FreeRDP_UserSpecifiedServerName. This function returns the correct name to use.

Parameters

settings The settings to query, must not be NULL.

Returns: A string pointer or NULL in case of failure.

Definition at line 1824 of file common/settings.c.

 {
   WINPR_ASSERT(settings);
   const char* hostname = settings->ServerHostname;
  
   if (settings->UserSpecifiedServerName)
     hostname = settings->UserSpecifiedServerName;
  
   return hostname;
 }

◆ freerdp_settings_get_string()

FREERDP_API const char* freerdp_settings_get_string	(	const rdpSettings *	settings,
		FreeRDP_Settings_Keys_String	id
	)

Returns a immutable string settings value.

Parameters

settings	A pointer to the settings to query, must not be NULL.
id	The key to query

Returns: the immutable string pointer

Definition at line 2672 of file settings_getters.c.

 {
   WINPR_ASSERT(settings);
  
   switch (id)
   {
     case FreeRDP_AadServerHostname:
       return settings->AadServerHostname;
  
     case FreeRDP_AcceptedCert:
       return settings->AcceptedCert;
  
     case FreeRDP_ActionScript:
       return settings->ActionScript;
  
     case FreeRDP_AllowedTlsCiphers:
       return settings->AllowedTlsCiphers;
  
     case FreeRDP_AlternateShell:
       return settings->AlternateShell;
  
     case FreeRDP_AssistanceFile:
       return settings->AssistanceFile;
  
     case FreeRDP_AuthenticationPackageList:
       return settings->AuthenticationPackageList;
  
     case FreeRDP_AuthenticationServiceClass:
       return settings->AuthenticationServiceClass;
  
     case FreeRDP_BitmapCachePersistFile:
       return settings->BitmapCachePersistFile;
  
     case FreeRDP_CardName:
       return settings->CardName;
  
     case FreeRDP_CertificateAcceptedFingerprints:
       return settings->CertificateAcceptedFingerprints;
  
     case FreeRDP_CertificateName:
       return settings->CertificateName;
  
     case FreeRDP_ClientAddress:
       return settings->ClientAddress;
  
     case FreeRDP_ClientDir:
       return settings->ClientDir;
  
     case FreeRDP_ClientHostname:
       return settings->ClientHostname;
  
     case FreeRDP_ClientProductId:
       return settings->ClientProductId;
  
     case FreeRDP_ClipboardUseSelection:
       return settings->ClipboardUseSelection;
  
     case FreeRDP_ComputerName:
       return settings->ComputerName;
  
     case FreeRDP_ConfigPath:
       return settings->ConfigPath;
  
     case FreeRDP_ConnectionFile:
       return settings->ConnectionFile;
  
     case FreeRDP_ContainerName:
       return settings->ContainerName;
  
     case FreeRDP_CspName:
       return settings->CspName;
  
     case FreeRDP_CurrentPath:
       return settings->CurrentPath;
  
     case FreeRDP_Domain:
       return settings->Domain;
  
     case FreeRDP_DrivesToRedirect:
       return settings->DrivesToRedirect;
  
     case FreeRDP_DumpRemoteFxFile:
       return settings->DumpRemoteFxFile;
  
     case FreeRDP_DynamicDSTTimeZoneKeyName:
       return settings->DynamicDSTTimeZoneKeyName;
  
     case FreeRDP_GatewayAcceptedCert:
       return settings->GatewayAcceptedCert;
  
     case FreeRDP_GatewayAccessToken:
       return settings->GatewayAccessToken;
  
     case FreeRDP_GatewayAvdAadtenantid:
       return settings->GatewayAvdAadtenantid;
  
     case FreeRDP_GatewayAvdActivityhint:
       return settings->GatewayAvdActivityhint;
  
     case FreeRDP_GatewayAvdArmpath:
       return settings->GatewayAvdArmpath;
  
     case FreeRDP_GatewayAvdDiagnosticserviceurl:
       return settings->GatewayAvdDiagnosticserviceurl;
  
     case FreeRDP_GatewayAvdGeo:
       return settings->GatewayAvdGeo;
  
     case FreeRDP_GatewayAvdHubdiscoverygeourl:
       return settings->GatewayAvdHubdiscoverygeourl;
  
     case FreeRDP_GatewayAvdWvdEndpointPool:
       return settings->GatewayAvdWvdEndpointPool;
  
     case FreeRDP_GatewayDomain:
       return settings->GatewayDomain;
  
     case FreeRDP_GatewayHostname:
       return settings->GatewayHostname;
  
     case FreeRDP_GatewayHttpExtAuthBearer:
       return settings->GatewayHttpExtAuthBearer;
  
     case FreeRDP_GatewayPassword:
       return settings->GatewayPassword;
  
     case FreeRDP_GatewayUrl:
       return settings->GatewayUrl;
  
     case FreeRDP_GatewayUsername:
       return settings->GatewayUsername;
  
     case FreeRDP_HomePath:
       return settings->HomePath;
  
     case FreeRDP_ImeFileName:
       return settings->ImeFileName;
  
     case FreeRDP_KerberosArmor:
       return settings->KerberosArmor;
  
     case FreeRDP_KerberosCache:
       return settings->KerberosCache;
  
     case FreeRDP_KerberosKdcUrl:
       return settings->KerberosKdcUrl;
  
     case FreeRDP_KerberosKeytab:
       return settings->KerberosKeytab;
  
     case FreeRDP_KerberosLifeTime:
       return settings->KerberosLifeTime;
  
     case FreeRDP_KerberosRealm:
       return settings->KerberosRealm;
  
     case FreeRDP_KerberosRenewableLifeTime:
       return settings->KerberosRenewableLifeTime;
  
     case FreeRDP_KerberosStartTime:
       return settings->KerberosStartTime;
  
     case FreeRDP_KeyboardPipeName:
       return settings->KeyboardPipeName;
  
     case FreeRDP_KeyboardRemappingList:
       return settings->KeyboardRemappingList;
  
     case FreeRDP_NtlmSamFile:
       return settings->NtlmSamFile;
  
     case FreeRDP_Password:
       return settings->Password;
  
     case FreeRDP_PasswordHash:
       return settings->PasswordHash;
  
     case FreeRDP_Pkcs11Module:
       return settings->Pkcs11Module;
  
     case FreeRDP_PkinitAnchors:
       return settings->PkinitAnchors;
  
     case FreeRDP_PlayRemoteFxFile:
       return settings->PlayRemoteFxFile;
  
     case FreeRDP_PreconnectionBlob:
       return settings->PreconnectionBlob;
  
     case FreeRDP_ProxyHostname:
       return settings->ProxyHostname;
  
     case FreeRDP_ProxyPassword:
       return settings->ProxyPassword;
  
     case FreeRDP_ProxyUsername:
       return settings->ProxyUsername;
  
     case FreeRDP_RDP2TCPArgs:
       return settings->RDP2TCPArgs;
  
     case FreeRDP_ReaderName:
       return settings->ReaderName;
  
     case FreeRDP_RedirectionAcceptedCert:
       return settings->RedirectionAcceptedCert;
  
     case FreeRDP_RedirectionDomain:
       return settings->RedirectionDomain;
  
     case FreeRDP_RedirectionTargetFQDN:
       return settings->RedirectionTargetFQDN;
  
     case FreeRDP_RedirectionTargetNetBiosName:
       return settings->RedirectionTargetNetBiosName;
  
     case FreeRDP_RedirectionUsername:
       return settings->RedirectionUsername;
  
     case FreeRDP_RemoteApplicationCmdLine:
       return settings->RemoteApplicationCmdLine;
  
     case FreeRDP_RemoteApplicationFile:
       return settings->RemoteApplicationFile;
  
     case FreeRDP_RemoteApplicationGuid:
       return settings->RemoteApplicationGuid;
  
     case FreeRDP_RemoteApplicationIcon:
       return settings->RemoteApplicationIcon;
  
     case FreeRDP_RemoteApplicationName:
       return settings->RemoteApplicationName;
  
     case FreeRDP_RemoteApplicationProgram:
       return settings->RemoteApplicationProgram;
  
     case FreeRDP_RemoteApplicationWorkingDir:
       return settings->RemoteApplicationWorkingDir;
  
     case FreeRDP_RemoteAssistancePassStub:
       return settings->RemoteAssistancePassStub;
  
     case FreeRDP_RemoteAssistancePassword:
       return settings->RemoteAssistancePassword;
  
     case FreeRDP_RemoteAssistanceRCTicket:
       return settings->RemoteAssistanceRCTicket;
  
     case FreeRDP_RemoteAssistanceSessionId:
       return settings->RemoteAssistanceSessionId;
  
     case FreeRDP_ServerHostname:
       return settings->ServerHostname;
  
     case FreeRDP_ServerLicenseCompanyName:
       return settings->ServerLicenseCompanyName;
  
     case FreeRDP_ServerLicenseProductName:
       return settings->ServerLicenseProductName;
  
     case FreeRDP_ShellWorkingDirectory:
       return settings->ShellWorkingDirectory;
  
     case FreeRDP_SmartcardCertificate:
       return settings->SmartcardCertificate;
  
     case FreeRDP_SmartcardPrivateKey:
       return settings->SmartcardPrivateKey;
  
     case FreeRDP_SspiModule:
       return settings->SspiModule;
  
     case FreeRDP_TargetNetAddress:
       return settings->TargetNetAddress;
  
     case FreeRDP_TerminalDescriptor:
       return settings->TerminalDescriptor;
  
     case FreeRDP_TlsSecretsFile:
       return settings->TlsSecretsFile;
  
     case FreeRDP_TransportDumpFile:
       return settings->TransportDumpFile;
  
     case FreeRDP_UserSpecifiedServerName:
       return settings->UserSpecifiedServerName;
  
     case FreeRDP_Username:
       return settings->Username;
  
     case FreeRDP_WinSCardModule:
       return settings->WinSCardModule;
  
     case FreeRDP_WindowTitle:
       return settings->WindowTitle;
  
     case FreeRDP_WmClass:
       return settings->WmClass;
  
     default:
       WLog_ERR(TAG, "Invalid key index %" PRIuz " [%s|%s]", id,
                freerdp_settings_get_name_for_key(id),
                freerdp_settings_get_type_name_for_key(id));
       WINPR_ASSERT(FALSE);
       return NULL;
   }
 }

References freerdp_settings_get_name_for_key(), and freerdp_settings_get_type_name_for_key().

Referenced by freerdp_settings_append_string(), freerdp_settings_copy_item(), freerdp_settings_dump(), freerdp_settings_get_string_as_utf16(), and freerdp_settings_print_diff().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ freerdp_settings_get_string_as_utf16()

FREERDP_API WCHAR* freerdp_settings_get_string_as_utf16	(	const rdpSettings *	settings,
		FreeRDP_Settings_Keys_String	id,
		size_t *	pCharLen
	)

Return an allocated UTF16 string.

Parameters

settings	A pointer to the settings struct to use
id	The settings identifier

Returns: An allocated, '\0' terminated WCHAR string or NULL

Definition at line 2094 of file common/settings.c.

 {
   const char* str = freerdp_settings_get_string(settings, id);
   if (pCharLen)
     *pCharLen = 0;
   if (!str)
     return NULL;
   return ConvertUtf8ToWCharAlloc(str, pCharLen);
 }

References freerdp_settings_get_string().

Here is the call graph for this function:

◆ freerdp_settings_get_string_writable()

FREERDP_API char* freerdp_settings_get_string_writable	(	rdpSettings *	settings,
		FreeRDP_Settings_Keys_String	id
	)

Returns a string settings value.

Parameters

settings	A pointer to the settings to query, must not be NULL.
id	The key to query

Returns: the string pointer

Definition at line 2982 of file settings_getters.c.

 {
   WINPR_ASSERT(settings);
  
   switch (id)
   {
     case FreeRDP_AadServerHostname:
       return settings->AadServerHostname;
  
     case FreeRDP_AcceptedCert:
       return settings->AcceptedCert;
  
     case FreeRDP_ActionScript:
       return settings->ActionScript;
  
     case FreeRDP_AllowedTlsCiphers:
       return settings->AllowedTlsCiphers;
  
     case FreeRDP_AlternateShell:
       return settings->AlternateShell;
  
     case FreeRDP_AssistanceFile:
       return settings->AssistanceFile;
  
     case FreeRDP_AuthenticationPackageList:
       return settings->AuthenticationPackageList;
  
     case FreeRDP_AuthenticationServiceClass:
       return settings->AuthenticationServiceClass;
  
     case FreeRDP_BitmapCachePersistFile:
       return settings->BitmapCachePersistFile;
  
     case FreeRDP_CardName:
       return settings->CardName;
  
     case FreeRDP_CertificateAcceptedFingerprints:
       return settings->CertificateAcceptedFingerprints;
  
     case FreeRDP_CertificateName:
       return settings->CertificateName;
  
     case FreeRDP_ClientAddress:
       return settings->ClientAddress;
  
     case FreeRDP_ClientDir:
       return settings->ClientDir;
  
     case FreeRDP_ClientHostname:
       return settings->ClientHostname;
  
     case FreeRDP_ClientProductId:
       return settings->ClientProductId;
  
     case FreeRDP_ClipboardUseSelection:
       return settings->ClipboardUseSelection;
  
     case FreeRDP_ComputerName:
       return settings->ComputerName;
  
     case FreeRDP_ConfigPath:
       return settings->ConfigPath;
  
     case FreeRDP_ConnectionFile:
       return settings->ConnectionFile;
  
     case FreeRDP_ContainerName:
       return settings->ContainerName;
  
     case FreeRDP_CspName:
       return settings->CspName;
  
     case FreeRDP_CurrentPath:
       return settings->CurrentPath;
  
     case FreeRDP_Domain:
       return settings->Domain;
  
     case FreeRDP_DrivesToRedirect:
       return settings->DrivesToRedirect;
  
     case FreeRDP_DumpRemoteFxFile:
       return settings->DumpRemoteFxFile;
  
     case FreeRDP_DynamicDSTTimeZoneKeyName:
       return settings->DynamicDSTTimeZoneKeyName;
  
     case FreeRDP_GatewayAcceptedCert:
       return settings->GatewayAcceptedCert;
  
     case FreeRDP_GatewayAccessToken:
       return settings->GatewayAccessToken;
  
     case FreeRDP_GatewayAvdAadtenantid:
       return settings->GatewayAvdAadtenantid;
  
     case FreeRDP_GatewayAvdActivityhint:
       return settings->GatewayAvdActivityhint;
  
     case FreeRDP_GatewayAvdArmpath:
       return settings->GatewayAvdArmpath;
  
     case FreeRDP_GatewayAvdDiagnosticserviceurl:
       return settings->GatewayAvdDiagnosticserviceurl;
  
     case FreeRDP_GatewayAvdGeo:
       return settings->GatewayAvdGeo;
  
     case FreeRDP_GatewayAvdHubdiscoverygeourl:
       return settings->GatewayAvdHubdiscoverygeourl;
  
     case FreeRDP_GatewayAvdWvdEndpointPool:
       return settings->GatewayAvdWvdEndpointPool;
  
     case FreeRDP_GatewayDomain:
       return settings->GatewayDomain;
  
     case FreeRDP_GatewayHostname:
       return settings->GatewayHostname;
  
     case FreeRDP_GatewayHttpExtAuthBearer:
       return settings->GatewayHttpExtAuthBearer;
  
     case FreeRDP_GatewayPassword:
       return settings->GatewayPassword;
  
     case FreeRDP_GatewayUrl:
       return settings->GatewayUrl;
  
     case FreeRDP_GatewayUsername:
       return settings->GatewayUsername;
  
     case FreeRDP_HomePath:
       return settings->HomePath;
  
     case FreeRDP_ImeFileName:
       return settings->ImeFileName;
  
     case FreeRDP_KerberosArmor:
       return settings->KerberosArmor;
  
     case FreeRDP_KerberosCache:
       return settings->KerberosCache;
  
     case FreeRDP_KerberosKdcUrl:
       return settings->KerberosKdcUrl;
  
     case FreeRDP_KerberosKeytab:
       return settings->KerberosKeytab;
  
     case FreeRDP_KerberosLifeTime:
       return settings->KerberosLifeTime;
  
     case FreeRDP_KerberosRealm:
       return settings->KerberosRealm;
  
     case FreeRDP_KerberosRenewableLifeTime:
       return settings->KerberosRenewableLifeTime;
  
     case FreeRDP_KerberosStartTime:
       return settings->KerberosStartTime;
  
     case FreeRDP_KeyboardPipeName:
       return settings->KeyboardPipeName;
  
     case FreeRDP_KeyboardRemappingList:
       return settings->KeyboardRemappingList;
  
     case FreeRDP_NtlmSamFile:
       return settings->NtlmSamFile;
  
     case FreeRDP_Password:
       return settings->Password;
  
     case FreeRDP_PasswordHash:
       return settings->PasswordHash;
  
     case FreeRDP_Pkcs11Module:
       return settings->Pkcs11Module;
  
     case FreeRDP_PkinitAnchors:
       return settings->PkinitAnchors;
  
     case FreeRDP_PlayRemoteFxFile:
       return settings->PlayRemoteFxFile;
  
     case FreeRDP_PreconnectionBlob:
       return settings->PreconnectionBlob;
  
     case FreeRDP_ProxyHostname:
       return settings->ProxyHostname;
  
     case FreeRDP_ProxyPassword:
       return settings->ProxyPassword;
  
     case FreeRDP_ProxyUsername:
       return settings->ProxyUsername;
  
     case FreeRDP_RDP2TCPArgs:
       return settings->RDP2TCPArgs;
  
     case FreeRDP_ReaderName:
       return settings->ReaderName;
  
     case FreeRDP_RedirectionAcceptedCert:
       return settings->RedirectionAcceptedCert;
  
     case FreeRDP_RedirectionDomain:
       return settings->RedirectionDomain;
  
     case FreeRDP_RedirectionTargetFQDN:
       return settings->RedirectionTargetFQDN;
  
     case FreeRDP_RedirectionTargetNetBiosName:
       return settings->RedirectionTargetNetBiosName;
  
     case FreeRDP_RedirectionUsername:
       return settings->RedirectionUsername;
  
     case FreeRDP_RemoteApplicationCmdLine:
       return settings->RemoteApplicationCmdLine;
  
     case FreeRDP_RemoteApplicationFile:
       return settings->RemoteApplicationFile;
  
     case FreeRDP_RemoteApplicationGuid:
       return settings->RemoteApplicationGuid;
  
     case FreeRDP_RemoteApplicationIcon:
       return settings->RemoteApplicationIcon;
  
     case FreeRDP_RemoteApplicationName:
       return settings->RemoteApplicationName;
  
     case FreeRDP_RemoteApplicationProgram:
       return settings->RemoteApplicationProgram;
  
     case FreeRDP_RemoteApplicationWorkingDir:
       return settings->RemoteApplicationWorkingDir;
  
     case FreeRDP_RemoteAssistancePassStub:
       return settings->RemoteAssistancePassStub;
  
     case FreeRDP_RemoteAssistancePassword:
       return settings->RemoteAssistancePassword;
  
     case FreeRDP_RemoteAssistanceRCTicket:
       return settings->RemoteAssistanceRCTicket;
  
     case FreeRDP_RemoteAssistanceSessionId:
       return settings->RemoteAssistanceSessionId;
  
     case FreeRDP_ServerHostname:
       return settings->ServerHostname;
  
     case FreeRDP_ServerLicenseCompanyName:
       return settings->ServerLicenseCompanyName;
  
     case FreeRDP_ServerLicenseProductName:
       return settings->ServerLicenseProductName;
  
     case FreeRDP_ShellWorkingDirectory:
       return settings->ShellWorkingDirectory;
  
     case FreeRDP_SmartcardCertificate:
       return settings->SmartcardCertificate;
  
     case FreeRDP_SmartcardPrivateKey:
       return settings->SmartcardPrivateKey;
  
     case FreeRDP_SspiModule:
       return settings->SspiModule;
  
     case FreeRDP_TargetNetAddress:
       return settings->TargetNetAddress;
  
     case FreeRDP_TerminalDescriptor:
       return settings->TerminalDescriptor;
  
     case FreeRDP_TlsSecretsFile:
       return settings->TlsSecretsFile;
  
     case FreeRDP_TransportDumpFile:
       return settings->TransportDumpFile;
  
     case FreeRDP_UserSpecifiedServerName:
       return settings->UserSpecifiedServerName;
  
     case FreeRDP_Username:
       return settings->Username;
  
     case FreeRDP_WinSCardModule:
       return settings->WinSCardModule;
  
     case FreeRDP_WindowTitle:
       return settings->WindowTitle;
  
     case FreeRDP_WmClass:
       return settings->WmClass;
  
     default:
       WLog_ERR(TAG, "Invalid key index %" PRIuz " [%s|%s]", id,
                freerdp_settings_get_name_for_key(id),
                freerdp_settings_get_type_name_for_key(id));
       WINPR_ASSERT(FALSE);
       return NULL;
   }
 }

References freerdp_settings_get_name_for_key(), and freerdp_settings_get_type_name_for_key().

Here is the call graph for this function:

◆ freerdp_settings_get_type_for_key()

FREERDP_API SSIZE_T freerdp_settings_get_type_for_key ( SSIZE_T key )

Get a key type for the key index.

Parameters

key	The key index like FreeRDP_ServerMode

Returns: The key type (e.g. FREERDP_SETTINGS_TYPE_BOOL) or -1 in case of an error (e.g. name does not exist)

Definition at line 399 of file settings_str.c.

 {
   for (size_t x = 0; x < ARRAYSIZE(settings_map); x++)
   {
     const struct settings_str_entry* cur = &settings_map[x];
     if (cur->id == key)
       return cur->type;
   }
   return -1;
 }

Referenced by freerdp_settings_copy_item(), and freerdp_settings_get_type_name_for_key().

Here is the caller graph for this function:

◆ freerdp_settings_get_type_for_name()

FREERDP_API SSIZE_T freerdp_settings_get_type_for_name ( const char * value )

Get a key type for the name string of that key.

Parameters

value A key name string like FreeRDP_ServerMode

Returns: The key type (e.g. FREERDP_SETTINGS_TYPE_BOOL) or -1 in case of an error (e.g. name does not exist)

Definition at line 353 of file settings_str.c.

 {
   WINPR_ASSERT(value);
  
   for (size_t x = 0; x < ARRAYSIZE(settings_map); x++)
   {
     const struct settings_str_entry* cur = &settings_map[x];
     if (strcmp(value, cur->str) == 0)
       return cur->type;
   }
   return -1;
 }

◆ freerdp_settings_get_type_name_for_key()

FREERDP_API const char* freerdp_settings_get_type_name_for_key ( SSIZE_T key )

Returns the type name for a key.

Parameters

key	the key number to stringify

Returns: the type name of the key or FREERDP_SETTINGS_TYPE_UNKNOWN

Definition at line 366 of file settings_str.c.

 {
   const SSIZE_T type = freerdp_settings_get_type_for_key(key);
   return freerdp_settings_get_type_name_for_type(type);
 }

References freerdp_settings_get_type_for_key(), and freerdp_settings_get_type_name_for_type().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ freerdp_settings_get_type_name_for_type()

FREERDP_API const char* freerdp_settings_get_type_name_for_type ( SSIZE_T type )

Returns the type name for a type.

Parameters

type	the type to stringify

Returns: the name of the key or FREERDP_SETTINGS_TYPE_UNKNOWN

Definition at line 372 of file settings_str.c.

 {
   switch (type)
   {
     case FREERDP_SETTINGS_TYPE_BOOL:
       return "FREERDP_SETTINGS_TYPE_BOOL";
     case FREERDP_SETTINGS_TYPE_UINT16:
       return "FREERDP_SETTINGS_TYPE_UINT16";
     case FREERDP_SETTINGS_TYPE_INT16:
       return "FREERDP_SETTINGS_TYPE_INT16";
     case FREERDP_SETTINGS_TYPE_UINT32:
       return "FREERDP_SETTINGS_TYPE_UINT32";
     case FREERDP_SETTINGS_TYPE_INT32:
       return "FREERDP_SETTINGS_TYPE_INT32";
     case FREERDP_SETTINGS_TYPE_UINT64:
       return "FREERDP_SETTINGS_TYPE_UINT64";
     case FREERDP_SETTINGS_TYPE_INT64:
       return "FREERDP_SETTINGS_TYPE_INT64";
     case FREERDP_SETTINGS_TYPE_STRING:
       return "FREERDP_SETTINGS_TYPE_STRING";
     case FREERDP_SETTINGS_TYPE_POINTER:
       return "FREERDP_SETTINGS_TYPE_POINTER";
     default:
       return "FREERDP_SETTINGS_TYPE_UNKNOWN";
   }
 }

Referenced by freerdp_settings_get_type_name_for_key().

Here is the caller graph for this function:

◆ freerdp_settings_get_uint16()

FREERDP_API UINT16 freerdp_settings_get_uint16	(	const rdpSettings *	settings,
		FreeRDP_Settings_Keys_UInt16	id
	)

Returns a UINT16 settings value.

Parameters

settings	A pointer to the settings to query, must not be NULL.
id	The key to query

Returns: the value of the UINT16 key

Definition at line 1444 of file settings_getters.c.

 {
   WINPR_ASSERT(settings);
  
   switch (id)
   {
     case FreeRDP_CapsGeneralCompressionLevel:
       return settings->CapsGeneralCompressionLevel;
  
     case FreeRDP_CapsGeneralCompressionTypes:
       return settings->CapsGeneralCompressionTypes;
  
     case FreeRDP_CapsProtocolVersion:
       return settings->CapsProtocolVersion;
  
     case FreeRDP_CapsRemoteUnshareFlag:
       return settings->CapsRemoteUnshareFlag;
  
     case FreeRDP_CapsUpdateCapabilityFlag:
       return settings->CapsUpdateCapabilityFlag;
  
     case FreeRDP_DesktopOrientation:
       return settings->DesktopOrientation;
  
     case FreeRDP_OrderSupportFlags:
       return settings->OrderSupportFlags;
  
     case FreeRDP_OrderSupportFlagsEx:
       return settings->OrderSupportFlagsEx;
  
     case FreeRDP_ProxyPort:
       return settings->ProxyPort;
  
     case FreeRDP_SupportedColorDepths:
       return settings->SupportedColorDepths;
  
     case FreeRDP_TLSMaxVersion:
       return settings->TLSMaxVersion;
  
     case FreeRDP_TLSMinVersion:
       return settings->TLSMinVersion;
  
     case FreeRDP_TextANSICodePage:
       return settings->TextANSICodePage;
  
     default:
       WLog_ERR(TAG, "Invalid key index %" PRIuz " [%s|%s]", id,
                freerdp_settings_get_name_for_key(id),
                freerdp_settings_get_type_name_for_key(id));
       WINPR_ASSERT(FALSE);
       return 0;
   }
 }

References freerdp_settings_get_name_for_key(), and freerdp_settings_get_type_name_for_key().

Referenced by freerdp_settings_copy_item(), freerdp_settings_dump(), and freerdp_settings_print_diff().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ freerdp_settings_get_uint32()

FREERDP_API UINT32 freerdp_settings_get_uint32	(	const rdpSettings *	settings,
		FreeRDP_Settings_Keys_UInt32	id
	)

Returns a UINT32 settings value.

Parameters

settings	A pointer to the settings to query, must not be NULL.
id	The key to query

Returns: the value of the UINT32 key

Definition at line 1613 of file settings_getters.c.

 {
   WINPR_ASSERT(settings);
  
   switch (id)
   {
     case FreeRDP_AcceptedCertLength:
       return settings->AcceptedCertLength;
  
     case FreeRDP_AuthenticationLevel:
       return settings->AuthenticationLevel;
  
     case FreeRDP_AutoReconnectMaxRetries:
       return settings->AutoReconnectMaxRetries;
  
     case FreeRDP_BitmapCacheV2NumCells:
       return settings->BitmapCacheV2NumCells;
  
     case FreeRDP_BitmapCacheV3CodecId:
       return settings->BitmapCacheV3CodecId;
  
     case FreeRDP_BitmapCacheVersion:
       return settings->BitmapCacheVersion;
  
     case FreeRDP_BrushSupportLevel:
       return settings->BrushSupportLevel;
  
     case FreeRDP_ChannelCount:
       return settings->ChannelCount;
  
     case FreeRDP_ChannelDefArraySize:
       return settings->ChannelDefArraySize;
  
     case FreeRDP_ClientBuild:
       return settings->ClientBuild;
  
     case FreeRDP_ClientRandomLength:
       return settings->ClientRandomLength;
  
     case FreeRDP_ClientSessionId:
       return settings->ClientSessionId;
  
     case FreeRDP_ClipboardFeatureMask:
       return settings->ClipboardFeatureMask;
  
     case FreeRDP_ClusterInfoFlags:
       return settings->ClusterInfoFlags;
  
     case FreeRDP_ColorDepth:
       return settings->ColorDepth;
  
     case FreeRDP_ColorPointerCacheSize:
       return settings->ColorPointerCacheSize;
  
     case FreeRDP_CompDeskSupportLevel:
       return settings->CompDeskSupportLevel;
  
     case FreeRDP_CompressionLevel:
       return settings->CompressionLevel;
  
     case FreeRDP_ConnectionType:
       return settings->ConnectionType;
  
     case FreeRDP_CookieMaxLength:
       return settings->CookieMaxLength;
  
     case FreeRDP_DesktopHeight:
       return settings->DesktopHeight;
  
     case FreeRDP_DesktopPhysicalHeight:
       return settings->DesktopPhysicalHeight;
  
     case FreeRDP_DesktopPhysicalWidth:
       return settings->DesktopPhysicalWidth;
  
     case FreeRDP_DesktopPosX:
       return settings->DesktopPosX;
  
     case FreeRDP_DesktopPosY:
       return settings->DesktopPosY;
  
     case FreeRDP_DesktopScaleFactor:
       return settings->DesktopScaleFactor;
  
     case FreeRDP_DesktopWidth:
       return settings->DesktopWidth;
  
     case FreeRDP_DeviceArraySize:
       return settings->DeviceArraySize;
  
     case FreeRDP_DeviceCount:
       return settings->DeviceCount;
  
     case FreeRDP_DeviceScaleFactor:
       return settings->DeviceScaleFactor;
  
     case FreeRDP_DrawNineGridCacheEntries:
       return settings->DrawNineGridCacheEntries;
  
     case FreeRDP_DrawNineGridCacheSize:
       return settings->DrawNineGridCacheSize;
  
     case FreeRDP_DynamicChannelArraySize:
       return settings->DynamicChannelArraySize;
  
     case FreeRDP_DynamicChannelCount:
       return settings->DynamicChannelCount;
  
     case FreeRDP_EarlyCapabilityFlags:
       return settings->EarlyCapabilityFlags;
  
     case FreeRDP_EncryptionLevel:
       return settings->EncryptionLevel;
  
     case FreeRDP_EncryptionMethods:
       return settings->EncryptionMethods;
  
     case FreeRDP_ExtEncryptionMethods:
       return settings->ExtEncryptionMethods;
  
     case FreeRDP_FakeMouseMotionInterval:
       return settings->FakeMouseMotionInterval;
  
     case FreeRDP_Floatbar:
       return settings->Floatbar;
  
     case FreeRDP_ForceIPvX:
       return settings->ForceIPvX;
  
     case FreeRDP_FrameAcknowledge:
       return settings->FrameAcknowledge;
  
     case FreeRDP_GatewayAcceptedCertLength:
       return settings->GatewayAcceptedCertLength;
  
     case FreeRDP_GatewayCredentialsSource:
       return settings->GatewayCredentialsSource;
  
     case FreeRDP_GatewayPort:
       return settings->GatewayPort;
  
     case FreeRDP_GatewayUsageMethod:
       return settings->GatewayUsageMethod;
  
     case FreeRDP_GfxCapsFilter:
       return settings->GfxCapsFilter;
  
     case FreeRDP_GlyphSupportLevel:
       return settings->GlyphSupportLevel;
  
     case FreeRDP_JpegCodecId:
       return settings->JpegCodecId;
  
     case FreeRDP_JpegQuality:
       return settings->JpegQuality;
  
     case FreeRDP_KeySpec:
       return settings->KeySpec;
  
     case FreeRDP_KeyboardCodePage:
       return settings->KeyboardCodePage;
  
     case FreeRDP_KeyboardFunctionKey:
       return settings->KeyboardFunctionKey;
  
     case FreeRDP_KeyboardHook:
       return settings->KeyboardHook;
  
     case FreeRDP_KeyboardLayout:
       return settings->KeyboardLayout;
  
     case FreeRDP_KeyboardSubType:
       return settings->KeyboardSubType;
  
     case FreeRDP_KeyboardType:
       return settings->KeyboardType;
  
     case FreeRDP_LargePointerFlag:
       return settings->LargePointerFlag;
  
     case FreeRDP_LoadBalanceInfoLength:
       return settings->LoadBalanceInfoLength;
  
     case FreeRDP_MonitorAttributeFlags:
       return settings->MonitorAttributeFlags;
  
     case FreeRDP_MonitorCount:
       return settings->MonitorCount;
  
     case FreeRDP_MonitorDefArraySize:
       return settings->MonitorDefArraySize;
  
     case FreeRDP_MonitorFlags:
       return settings->MonitorFlags;
  
     case FreeRDP_MonitorLocalShiftX:
       return settings->MonitorLocalShiftX;
  
     case FreeRDP_MonitorLocalShiftY:
       return settings->MonitorLocalShiftY;
  
     case FreeRDP_MultifragMaxRequestSize:
       return settings->MultifragMaxRequestSize;
  
     case FreeRDP_MultitransportFlags:
       return settings->MultitransportFlags;
  
     case FreeRDP_NSCodecColorLossLevel:
       return settings->NSCodecColorLossLevel;
  
     case FreeRDP_NSCodecId:
       return settings->NSCodecId;
  
     case FreeRDP_NegotiationFlags:
       return settings->NegotiationFlags;
  
     case FreeRDP_NumMonitorIds:
       return settings->NumMonitorIds;
  
     case FreeRDP_OffscreenCacheEntries:
       return settings->OffscreenCacheEntries;
  
     case FreeRDP_OffscreenCacheSize:
       return settings->OffscreenCacheSize;
  
     case FreeRDP_OffscreenSupportLevel:
       return settings->OffscreenSupportLevel;
  
     case FreeRDP_OsMajorType:
       return settings->OsMajorType;
  
     case FreeRDP_OsMinorType:
       return settings->OsMinorType;
  
     case FreeRDP_Password51Length:
       return settings->Password51Length;
  
     case FreeRDP_PduSource:
       return settings->PduSource;
  
     case FreeRDP_PercentScreen:
       return settings->PercentScreen;
  
     case FreeRDP_PerformanceFlags:
       return settings->PerformanceFlags;
  
     case FreeRDP_PointerCacheSize:
       return settings->PointerCacheSize;
  
     case FreeRDP_PreconnectionId:
       return settings->PreconnectionId;
  
     case FreeRDP_ProxyType:
       return settings->ProxyType;
  
     case FreeRDP_RdpVersion:
       return settings->RdpVersion;
  
     case FreeRDP_ReceivedCapabilitiesSize:
       return settings->ReceivedCapabilitiesSize;
  
     case FreeRDP_RedirectedSessionId:
       return settings->RedirectedSessionId;
  
     case FreeRDP_RedirectionAcceptedCertLength:
       return settings->RedirectionAcceptedCertLength;
  
     case FreeRDP_RedirectionFlags:
       return settings->RedirectionFlags;
  
     case FreeRDP_RedirectionGuidLength:
       return settings->RedirectionGuidLength;
  
     case FreeRDP_RedirectionPasswordLength:
       return settings->RedirectionPasswordLength;
  
     case FreeRDP_RedirectionPreferType:
       return settings->RedirectionPreferType;
  
     case FreeRDP_RedirectionTsvUrlLength:
       return settings->RedirectionTsvUrlLength;
  
     case FreeRDP_RemoteAppNumIconCacheEntries:
       return settings->RemoteAppNumIconCacheEntries;
  
     case FreeRDP_RemoteAppNumIconCaches:
       return settings->RemoteAppNumIconCaches;
  
     case FreeRDP_RemoteApplicationExpandCmdLine:
       return settings->RemoteApplicationExpandCmdLine;
  
     case FreeRDP_RemoteApplicationExpandWorkingDir:
       return settings->RemoteApplicationExpandWorkingDir;
  
     case FreeRDP_RemoteApplicationSupportLevel:
       return settings->RemoteApplicationSupportLevel;
  
     case FreeRDP_RemoteApplicationSupportMask:
       return settings->RemoteApplicationSupportMask;
  
     case FreeRDP_RemoteFxCaptureFlags:
       return settings->RemoteFxCaptureFlags;
  
     case FreeRDP_RemoteFxCodecId:
       return settings->RemoteFxCodecId;
  
     case FreeRDP_RemoteFxCodecMode:
       return settings->RemoteFxCodecMode;
  
     case FreeRDP_RemoteFxRlgrMode:
       return settings->RemoteFxRlgrMode;
  
     case FreeRDP_RemoteWndSupportLevel:
       return settings->RemoteWndSupportLevel;
  
     case FreeRDP_RequestedProtocols:
       return settings->RequestedProtocols;
  
     case FreeRDP_SelectedProtocol:
       return settings->SelectedProtocol;
  
     case FreeRDP_ServerCertificateLength:
       return settings->ServerCertificateLength;
  
     case FreeRDP_ServerLicenseProductIssuersCount:
       return settings->ServerLicenseProductIssuersCount;
  
     case FreeRDP_ServerLicenseProductVersion:
       return settings->ServerLicenseProductVersion;
  
     case FreeRDP_ServerPort:
       return settings->ServerPort;
  
     case FreeRDP_ServerRandomLength:
       return settings->ServerRandomLength;
  
     case FreeRDP_ShareId:
       return settings->ShareId;
  
     case FreeRDP_SmartSizingHeight:
       return settings->SmartSizingHeight;
  
     case FreeRDP_SmartSizingWidth:
       return settings->SmartSizingWidth;
  
     case FreeRDP_StaticChannelArraySize:
       return settings->StaticChannelArraySize;
  
     case FreeRDP_StaticChannelCount:
       return settings->StaticChannelCount;
  
     case FreeRDP_SurfaceCommandsSupported:
       return settings->SurfaceCommandsSupported;
  
     case FreeRDP_TargetNetAddressCount:
       return settings->TargetNetAddressCount;
  
     case FreeRDP_TcpAckTimeout:
       return settings->TcpAckTimeout;
  
     case FreeRDP_TcpConnectTimeout:
       return settings->TcpConnectTimeout;
  
     case FreeRDP_TcpKeepAliveDelay:
       return settings->TcpKeepAliveDelay;
  
     case FreeRDP_TcpKeepAliveInterval:
       return settings->TcpKeepAliveInterval;
  
     case FreeRDP_TcpKeepAliveRetries:
       return settings->TcpKeepAliveRetries;
  
     case FreeRDP_ThreadingFlags:
       return settings->ThreadingFlags;
  
     case FreeRDP_TlsSecLevel:
       return settings->TlsSecLevel;
  
     case FreeRDP_VCChunkSize:
       return settings->VCChunkSize;
  
     case FreeRDP_VCFlags:
       return settings->VCFlags;
  
     default:
       WLog_ERR(TAG, "Invalid key index %" PRIuz " [%s|%s]", id,
                freerdp_settings_get_name_for_key(id),
                freerdp_settings_get_type_name_for_key(id));
       WINPR_ASSERT(FALSE);
       return 0;
   }
 }

References freerdp_settings_get_name_for_key(), and freerdp_settings_get_type_name_for_key().

Referenced by freerdp_settings_copy_item(), freerdp_settings_dump(), freerdp_settings_print_diff(), and AppDelegate::rdpConnectError:.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ freerdp_settings_get_uint64()

FREERDP_API UINT64 freerdp_settings_get_uint64	(	const rdpSettings *	settings,
		FreeRDP_Settings_Keys_UInt64	id
	)

Returns a UINT64 settings value.

Parameters

settings	A pointer to the settings to query, must not be NULL.
id	The key to query

Returns: the value of the UINT64 key

Definition at line 2587 of file settings_getters.c.

 {
   WINPR_ASSERT(settings);
  
   switch (id)
   {
     case FreeRDP_ParentWindowId:
       return settings->ParentWindowId;
  
     default:
       WLog_ERR(TAG, "Invalid key index %" PRIuz " [%s|%s]", id,
                freerdp_settings_get_name_for_key(id),
                freerdp_settings_get_type_name_for_key(id));
       WINPR_ASSERT(FALSE);
       return 0;
   }
 }

References freerdp_settings_get_name_for_key(), and freerdp_settings_get_type_name_for_key().

Referenced by freerdp_settings_copy_item(), freerdp_settings_dump(), and freerdp_settings_print_diff().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ freerdp_settings_new()

FREERDP_API rdpSettings* freerdp_settings_new ( DWORD flags )

creates a new setting struct

Parameters

flags Flags for creation, use FREERDP_SETTINGS_SERVER_MODE for server settings, 0 for client.

Returns: A newly allocated settings struct or NULL

Definition at line 384 of file core/settings.c.

 {
   char* issuers[] = { "FreeRDP", "FreeRDP-licenser" };
   const BOOL server = (flags & FREERDP_SETTINGS_SERVER_MODE) != 0 ? TRUE : FALSE;
   const BOOL remote = (flags & FREERDP_SETTINGS_REMOTE_MODE) != 0 ? TRUE : FALSE;
   rdpSettings* settings = (rdpSettings*)calloc(1, sizeof(rdpSettings));
  
   if (!settings)
     return NULL;
  
   if (!freerdp_settings_set_uint32(settings, FreeRDP_SurfaceCommandsSupported,
                                    SURFCMDS_SET_SURFACE_BITS | SURFCMDS_STREAM_SURFACE_BITS |
                                        SURFCMDS_FRAME_MARKER))
     goto out_fail;
  
   if (!freerdp_settings_set_uint32(settings, FreeRDP_RemoteFxRlgrMode, RLGR3))
     goto out_fail;
  
   if (!freerdp_settings_set_uint16(settings, FreeRDP_CapsProtocolVersion,
                                    TS_CAPS_PROTOCOLVERSION))
     goto out_fail;
  
   if (!freerdp_settings_set_uint32(settings, FreeRDP_ClipboardFeatureMask,
                                    CLIPRDR_FLAG_DEFAULT_MASK))
     goto out_fail;
   if (!freerdp_settings_set_string(settings, FreeRDP_ServerLicenseCompanyName, "FreeRDP"))
     goto out_fail;
   if (!freerdp_settings_set_string(settings, FreeRDP_ServerLicenseProductName,
                                    "FreeRDP-licensing-server"))
     goto out_fail;
   if (!freerdp_settings_set_uint32(settings, FreeRDP_ServerLicenseProductVersion, 1))
     goto out_fail;
   if (!freerdp_server_license_issuers_copy(settings, issuers, ARRAYSIZE(issuers)))
     goto out_fail;
  
   if (!freerdp_settings_set_uint16(settings, FreeRDP_SupportedColorDepths,
                                    RNS_UD_32BPP_SUPPORT | RNS_UD_24BPP_SUPPORT |
                                        RNS_UD_16BPP_SUPPORT | RNS_UD_15BPP_SUPPORT))
     goto out_fail;
  
   if (!freerdp_settings_set_bool(settings, FreeRDP_UnicodeInput, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_HasHorizontalWheel, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_HasExtendedMouseEvent, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_HasQoeEvent, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_HasRelativeMouseEvent, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_HiDefRemoteApp, TRUE) ||
       !freerdp_settings_set_uint32(
           settings, FreeRDP_RemoteApplicationSupportMask,
           RAIL_LEVEL_SUPPORTED | RAIL_LEVEL_DOCKED_LANGBAR_SUPPORTED |
               RAIL_LEVEL_SHELL_INTEGRATION_SUPPORTED | RAIL_LEVEL_LANGUAGE_IME_SYNC_SUPPORTED |
               RAIL_LEVEL_SERVER_TO_CLIENT_IME_SYNC_SUPPORTED |
               RAIL_LEVEL_HIDE_MINIMIZED_APPS_SUPPORTED | RAIL_LEVEL_WINDOW_CLOAKING_SUPPORTED |
               RAIL_LEVEL_HANDSHAKE_EX_SUPPORTED) ||
       !freerdp_settings_set_uint16(settings, FreeRDP_TextANSICodePage, CP_UTF8) ||
       !freerdp_settings_set_uint16(settings, FreeRDP_OrderSupportFlags,
                                    NEGOTIATE_ORDER_SUPPORT | ZERO_BOUNDS_DELTA_SUPPORT |
                                        COLOR_INDEX_SUPPORT) ||
       !freerdp_settings_set_bool(settings, FreeRDP_SupportHeartbeatPdu, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_ServerMode, server) ||
       !freerdp_settings_set_bool(settings, FreeRDP_WaitForOutputBufferFlush, TRUE) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_ClusterInfoFlags, REDIRECTION_SUPPORTED) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_DesktopWidth, 1024) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_DesktopHeight, 768) ||
       !freerdp_settings_set_bool(settings, FreeRDP_Workarea, FALSE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_Fullscreen, FALSE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_GrabKeyboard, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_Decorations, TRUE) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_RdpVersion, RDP_VERSION_10_12) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_ColorDepth, 32) ||
       !freerdp_settings_set_bool(settings, FreeRDP_AadSecurity, FALSE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_ExtSecurity, FALSE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_NlaSecurity, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_TlsSecurity, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_RdpSecurity, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_RdstlsSecurity, FALSE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_NegotiateSecurityLayer, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_RestrictedAdminModeRequired, FALSE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_MstscCookieMode, FALSE) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_CookieMaxLength,
                                    DEFAULT_COOKIE_MAX_LENGTH) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_ClientBuild,
                                    18363) || /* Windows 10, Version 1909 */
       !freerdp_settings_set_uint32(settings, FreeRDP_KeyboardType, 4) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_KeyboardSubType, 0) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_KeyboardFunctionKey, 12) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_KeyboardLayout, 0) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_KeyboardHook,
                                    KEYBOARD_HOOK_FULLSCREEN_ONLY) ||
       !freerdp_settings_set_bool(settings, FreeRDP_UseRdpSecurityLayer, FALSE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_SaltedChecksum, TRUE) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_ServerPort, 3389) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_GatewayPort, 443) ||
       !freerdp_settings_set_bool(settings, FreeRDP_DesktopResize, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_ToggleFullscreen, TRUE) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_DesktopPosX, UINT32_MAX) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_DesktopPosY, UINT32_MAX) ||
       !freerdp_settings_set_bool(settings, FreeRDP_SoftwareGdi, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_UnmapButtons, FALSE) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_PerformanceFlags, PERF_FLAG_NONE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_AllowFontSmoothing, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_AllowDesktopComposition, FALSE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_DisableWallpaper, FALSE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_DisableFullWindowDrag, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_DisableMenuAnims, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_DisableThemes, FALSE) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_ConnectionType,
                                    CONNECTION_TYPE_AUTODETECT) ||
       !freerdp_settings_set_bool(settings, FreeRDP_NetworkAutoDetect, TRUE) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_EncryptionMethods, ENCRYPTION_METHOD_NONE) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_EncryptionLevel, ENCRYPTION_LEVEL_NONE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_FIPSMode, FALSE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_CompressionEnabled, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_LogonNotify, TRUE) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_BrushSupportLevel, BRUSH_COLOR_FULL) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_CompressionLevel, PACKET_COMPR_TYPE_RDP61) ||
       !freerdp_settings_set_bool(settings, FreeRDP_Authentication, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_AuthenticationOnly, FALSE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_CredentialsFromStdin, FALSE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_DisableCredentialsDelegation, FALSE) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_AuthenticationLevel, 2) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_ChannelCount, 0) ||
       !freerdp_settings_set_bool(settings, FreeRDP_CertificateCallbackPreferPEM, FALSE) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_KeySpec, AT_KEYEXCHANGE))
     goto out_fail;
  
   if (!freerdp_settings_set_pointer_len(settings, FreeRDP_ChannelDefArray, NULL,
                                         CHANNEL_MAX_COUNT))
     goto out_fail;
  
   if (!freerdp_settings_set_bool(settings, FreeRDP_SupportMonitorLayoutPdu, FALSE))
     goto out_fail;
  
   if (!freerdp_settings_set_uint32(settings, FreeRDP_MonitorCount, 0))
     goto out_fail;
  
   if (!freerdp_settings_set_pointer_len(settings, FreeRDP_MonitorDefArray, NULL, 32))
     goto out_fail;
  
   if (!freerdp_settings_set_uint32(settings, FreeRDP_MonitorLocalShiftX, 0))
     goto out_fail;
  
   if (!freerdp_settings_set_uint32(settings, FreeRDP_MonitorLocalShiftY, 0))
     goto out_fail;
  
   if (!freerdp_settings_set_pointer_len(settings, FreeRDP_MonitorIds, NULL, 0))
     goto out_fail;
  
   if (!freerdp_settings_set_uint32(settings, FreeRDP_MultitransportFlags,
                                    TRANSPORT_TYPE_UDP_FECR))
     goto out_fail;
   if (!freerdp_settings_set_bool(settings, FreeRDP_SupportMultitransport, TRUE))
     goto out_fail;
  
   if (!settings_get_computer_name(settings))
     goto out_fail;
  
   if (!freerdp_settings_set_pointer_len(settings, FreeRDP_RdpServerCertificate, NULL, 1))
     goto out_fail;
  
   if (!freerdp_capability_buffer_allocate(settings, 32))
     goto out_fail;
  
   {
     char tmp[32] = { 0 };
     if (!freerdp_settings_set_string_len(settings, FreeRDP_ClientProductId, tmp, sizeof(tmp)))
       goto out_fail;
   }
  
   {
     char ClientHostname[33] = { 0 };
     DWORD size = sizeof(ClientHostname) - 2;
     GetComputerNameA(ClientHostname, &size);
     if (!freerdp_settings_set_string(settings, FreeRDP_ClientHostname, ClientHostname))
       goto out_fail;
   }
  
   /* [MS-RDPBCGR] 2.2.7.1.5 Pointer Capability Set (TS_POINTER_CAPABILITYSET)
    *
    * if we are in server mode send a reasonable large cache size,
    * if we are in client mode just set the value to the maximum we want to
    * support and during capability exchange that size will be limited to the
    * sizes the server supports
    *
    * We have chosen 128 cursors in cache which is at worst 128 * 576kB (384x384 pixel cursor with
    * 32bit color depth)
    * */
   if (freerdp_settings_get_bool(settings, FreeRDP_ServerMode))
   {
     if (!freerdp_settings_set_uint32(settings, FreeRDP_PointerCacheSize, 25) ||
         !freerdp_settings_set_uint32(settings, FreeRDP_ColorPointerCacheSize, 25))
       goto out_fail;
   }
   else
   {
     if (!freerdp_settings_set_uint32(settings, FreeRDP_PointerCacheSize, 128) ||
         !freerdp_settings_set_uint32(settings, FreeRDP_ColorPointerCacheSize, 128))
       goto out_fail;
   }
  
   if (!freerdp_settings_set_uint32(settings, FreeRDP_LargePointerFlag,
                                    (LARGE_POINTER_FLAG_96x96 | LARGE_POINTER_FLAG_384x384)) ||
       !freerdp_settings_set_bool(settings, FreeRDP_SoundBeepsEnabled, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_DrawGdiPlusEnabled, FALSE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_DrawAllowSkipAlpha, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_DrawAllowColorSubsampling, FALSE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_DrawAllowDynamicColorFidelity, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_FrameMarkerCommandEnabled, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_SurfaceFrameMarkerEnabled, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_AllowCacheWaitingList, TRUE) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_BitmapCacheV2NumCells, 5))
     goto out_fail;
   settings->BitmapCacheV2CellInfo =
       (BITMAP_CACHE_V2_CELL_INFO*)calloc(6, sizeof(BITMAP_CACHE_V2_CELL_INFO));
  
   if (!settings->BitmapCacheV2CellInfo)
     goto out_fail;
  
   {
     BITMAP_CACHE_V2_CELL_INFO cache = { 0 };
     cache.numEntries = 600;
     if (!freerdp_settings_set_pointer_array(settings, FreeRDP_BitmapCacheV2CellInfo, 0,
                                             &cache) ||
         !freerdp_settings_set_pointer_array(settings, FreeRDP_BitmapCacheV2CellInfo, 1, &cache))
       goto out_fail;
     cache.numEntries = 2048;
     if (!freerdp_settings_set_pointer_array(settings, FreeRDP_BitmapCacheV2CellInfo, 2,
                                             &cache) ||
         !freerdp_settings_set_pointer_array(settings, FreeRDP_BitmapCacheV2CellInfo, 4, &cache))
       goto out_fail;
     cache.numEntries = 4096;
     if (!freerdp_settings_set_pointer_array(settings, FreeRDP_BitmapCacheV2CellInfo, 3, &cache))
       goto out_fail;
   }
   if (!freerdp_settings_set_bool(settings, FreeRDP_NoBitmapCompressionHeader, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_RefreshRect, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_SuppressOutput, TRUE) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_GlyphSupportLevel, GLYPH_SUPPORT_NONE))
     goto out_fail;
   settings->GlyphCache = calloc(10, sizeof(GLYPH_CACHE_DEFINITION));
  
   if (!settings->GlyphCache)
     goto out_fail;
  
   settings->FragCache = calloc(1, sizeof(GLYPH_CACHE_DEFINITION));
  
   if (!settings->FragCache)
     goto out_fail;
  
   for (size_t x = 0; x < 10; x++)
   {
     GLYPH_CACHE_DEFINITION cache = { 0 };
     cache.cacheEntries = 254;
     switch (x)
     {
       case 0:
       case 1:
         cache.cacheMaximumCellSize = 4;
         break;
       case 2:
       case 3:
         cache.cacheMaximumCellSize = 8;
         break;
       case 4:
         cache.cacheMaximumCellSize = 16;
         break;
       case 5:
         cache.cacheMaximumCellSize = 32;
         break;
       case 6:
         cache.cacheMaximumCellSize = 64;
         break;
       case 7:
         cache.cacheMaximumCellSize = 128;
         break;
       case 8:
         cache.cacheMaximumCellSize = 256;
         break;
       case 9:
         cache.cacheMaximumCellSize = 256;
         break;
     }
  
     if (!freerdp_settings_set_pointer_array(settings, FreeRDP_GlyphCache, x, &cache))
       goto out_fail;
   }
   {
     GLYPH_CACHE_DEFINITION cache = { 0 };
     cache.cacheEntries = 256;
     cache.cacheMaximumCellSize = 256;
     if (!freerdp_settings_set_pointer_array(settings, FreeRDP_FragCache, 0, &cache))
       goto out_fail;
   }
   if (!freerdp_settings_set_uint32(settings, FreeRDP_OffscreenSupportLevel, 0) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_OffscreenCacheSize, 7680) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_OffscreenCacheEntries, 2000) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_DrawNineGridCacheSize, 2560) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_DrawNineGridCacheEntries, 256) ||
       !freerdp_settings_set_string(settings, FreeRDP_ClientDir, client_dll) ||
       !freerdp_settings_get_string(settings, FreeRDP_ClientDir) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_RemoteWndSupportLevel,
                                    WINDOW_LEVEL_SUPPORTED | WINDOW_LEVEL_SUPPORTED_EX) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_RemoteAppNumIconCaches, 3) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_RemoteAppNumIconCacheEntries, 12) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_VCChunkSize,
                                    (server && !remote) ? CHANNEL_CHUNK_MAX_LENGTH
                                                        : CHANNEL_CHUNK_LENGTH) ||
       /* [MS-RDPBCGR] 2.2.7.2.7 Large Pointer Capability Set (TS_LARGE_POINTER_CAPABILITYSET)
          requires at least this size */
       !freerdp_settings_set_uint32(settings, FreeRDP_MultifragMaxRequestSize,
                                    server ? 0 : 608299) ||
       !freerdp_settings_set_bool(settings, FreeRDP_GatewayUseSameCredentials, FALSE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_GatewayBypassLocal, FALSE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_GatewayRpcTransport, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_GatewayHttpTransport, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_GatewayUdpTransport, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_GatewayHttpUseWebsockets, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_GatewayHttpExtAuthSspiNtlm, FALSE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_GatewayArmTransport, FALSE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_FastPathInput, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_FastPathOutput, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_LongCredentialsSupported, TRUE) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_FrameAcknowledge, 2) ||
       !freerdp_settings_set_bool(settings, FreeRDP_MouseMotion, TRUE) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_NSCodecColorLossLevel, 3) ||
       !freerdp_settings_set_bool(settings, FreeRDP_NSCodecAllowSubsampling, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_NSCodecAllowDynamicColorFidelity, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_AutoReconnectionEnabled, FALSE) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_AutoReconnectMaxRetries, 20) ||
       !freerdp_settings_set_bool(settings, FreeRDP_GfxThinClient, FALSE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_GfxSmallCache, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_GfxProgressive, FALSE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_GfxProgressiveV2, FALSE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_GfxPlanar, TRUE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_GfxH264, FALSE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_GfxAVC444, FALSE) ||
       !freerdp_settings_set_bool(settings, FreeRDP_GfxSendQoeAck, FALSE))
     goto out_fail;
   {
     ARC_CS_PRIVATE_PACKET cookie = { 0 };
     if (!freerdp_settings_set_pointer_len(settings, FreeRDP_ClientAutoReconnectCookie, &cookie,
                                           1))
       goto out_fail;
   }
   {
     ARC_SC_PRIVATE_PACKET cookie = { 0 };
     if (!freerdp_settings_set_pointer_len(settings, FreeRDP_ServerAutoReconnectCookie, &cookie,
                                           1))
       goto out_fail;
   }
  
   settings->ClientTimeZone = (LPTIME_ZONE_INFORMATION)calloc(1, sizeof(TIME_ZONE_INFORMATION));
  
   if (!settings->ClientTimeZone)
     goto out_fail;
  
   if (!settings->ServerMode)
   {
     DYNAMIC_TIME_ZONE_INFORMATION dynamic = { 0 };
     TIME_ZONE_INFORMATION* tz =
         freerdp_settings_get_pointer_writable(settings, FreeRDP_ClientTimeZone);
     WINPR_ASSERT(tz);
  
     GetTimeZoneInformation(tz);
     GetDynamicTimeZoneInformation(&dynamic);
  
     if (!freerdp_settings_set_string_from_utf16N(settings, FreeRDP_DynamicDSTTimeZoneKeyName,
                                                  dynamic.TimeZoneKeyName,
                                                  ARRAYSIZE(dynamic.TimeZoneKeyName)))
       goto out_fail;
  
     if (!freerdp_settings_set_bool(settings, FreeRDP_DynamicDaylightTimeDisabled,
                                    dynamic.DynamicDaylightTimeDisabled))
       goto out_fail;
   }
  
   if (!freerdp_settings_set_bool(settings, FreeRDP_TcpKeepAlive, TRUE) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_TcpKeepAliveRetries, 3) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_TcpKeepAliveDelay, 5) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_TcpKeepAliveInterval, 2) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_TcpAckTimeout, 9000) ||
       !freerdp_settings_set_uint32(settings, FreeRDP_TcpConnectTimeout, 15000))
     goto out_fail;
  
   if (!freerdp_settings_get_bool(settings, FreeRDP_ServerMode))
   {
     BOOL rc = FALSE;
     char* path = NULL;
     if (!freerdp_settings_set_bool(settings, FreeRDP_RedirectClipboard, TRUE))
       goto out_fail;
     /* these values are used only by the client part */
     path = GetKnownPath(KNOWN_PATH_HOME);
     rc = freerdp_settings_set_string(settings, FreeRDP_HomePath, path);
     free(path);
  
     if (!rc || !freerdp_settings_get_string(settings, FreeRDP_HomePath))
       goto out_fail;
  
     char* config = freerdp_settings_get_config_path();
     rc = freerdp_settings_set_string(settings, FreeRDP_ConfigPath, config);
     if (rc)
     {
       char* action = GetCombinedPath(config, "action.sh");
       rc = freerdp_settings_set_string(settings, FreeRDP_ActionScript, action);
       free(action);
     }
  
     free(config);
     if (!rc)
       goto out_fail;
   }
  
   settings_load_hkey_local_machine(settings);
  
   if (!freerdp_settings_set_bool(settings, FreeRDP_SmartcardLogon, FALSE))
     goto out_fail;
   if (!freerdp_settings_set_uint32(settings, FreeRDP_TlsSecLevel, 1))
     goto out_fail;
   settings->OrderSupport = calloc(1, 32);
  
   if (!freerdp_settings_set_uint16(settings, FreeRDP_TLSMinVersion, TLS1_VERSION))
     goto out_fail;
   if (!freerdp_settings_set_uint16(settings, FreeRDP_TLSMaxVersion, 0))
     goto out_fail;
  
   if (!settings->OrderSupport)
     goto out_fail;
  
   if (!freerdp_settings_set_default_order_support(settings))
     goto out_fail;
  
   const BOOL enable = freerdp_settings_get_bool(settings, FreeRDP_ServerMode);
  
   {
     const FreeRDP_Settings_Keys_Bool keys[] = { FreeRDP_SupportGraphicsPipeline,
                                               FreeRDP_SupportStatusInfoPdu,
                                               FreeRDP_SupportErrorInfoPdu,
                                               FreeRDP_SupportAsymetricKeys };
  
     for (size_t x = 0; x < ARRAYSIZE(keys); x++)
     {
       if (!freerdp_settings_set_bool(settings, keys[x], enable))
         goto out_fail;
     }
   }
  
   if (!freerdp_settings_set_bool(settings, FreeRDP_SupportDynamicTimeZone, TRUE))
     goto out_fail;
   if (!freerdp_settings_set_bool(settings, FreeRDP_SupportSkipChannelJoin, TRUE))
     goto out_fail;
  
   return settings;
 out_fail:
   freerdp_settings_free(settings);
   return NULL;
 }

References FREERDP_SETTINGS_SERVER_MODE.

◆ freerdp_settings_print_diff()

FREERDP_API BOOL freerdp_settings_print_diff	(	wLog *	log,
		DWORD	level,
		const rdpSettings *	src,
		const rdpSettings *	other
	)

Dumps the difference between two settings structs to a WLog.

Parameters

log	The logger to write to, must not be NULL.
level	The WLog level to use for the log entries.
src	A pointer to the settings to dump. May be NULL.
other	A pointer to the settings to dump. May be NULL.

Returns: TRUE if not equal, FALSE otherwise

Definition at line 94 of file settings_str.c.

 {
   BOOL rc = FALSE;
  
   WINPR_ASSERT(log);
   WINPR_ASSERT(settings);
   WINPR_ASSERT(other);
  
   for (size_t x = 0; x < ARRAYSIZE(settings_map); x++)
   {
     const struct settings_str_entry* cur = &settings_map[x];
     switch (cur->type)
     {
       case FREERDP_SETTINGS_TYPE_BOOL: /* bool */
       {
         BOOL sval =
             freerdp_settings_get_bool(settings, (FreeRDP_Settings_Keys_Bool)cur->id);
         BOOL cval = freerdp_settings_get_bool(other, (FreeRDP_Settings_Keys_Bool)cur->id);
         if (sval != cval)
         {
           rc = TRUE;
           WLog_Print(log, level, "%s [BOOL]: %s -> %s", cur->str, sval ? "TRUE" : "FALSE",
                      cval ? "TRUE" : "FALSE");
         }
       }
       break;
       case FREERDP_SETTINGS_TYPE_UINT16: /* UINT16 */
       {
         UINT16 sval =
             freerdp_settings_get_uint16(settings, (FreeRDP_Settings_Keys_UInt16)cur->id);
         UINT16 cval =
             freerdp_settings_get_uint16(other, (FreeRDP_Settings_Keys_UInt16)cur->id);
         if (sval != cval)
         {
           rc = TRUE;
           WLog_Print(log, level, "%s [UINT16]: %" PRIu16 " -> %" PRIu16, cur->str, sval,
                      cval);
         }
       }
       break;
       case FREERDP_SETTINGS_TYPE_INT16: /* INT16 */
       {
         INT16 sval =
             freerdp_settings_get_int16(settings, (FreeRDP_Settings_Keys_Int16)cur->id);
         INT16 cval =
             freerdp_settings_get_int16(other, (FreeRDP_Settings_Keys_Int16)cur->id);
         if (sval != cval)
         {
           rc = TRUE;
           WLog_Print(log, level, "%s [INT16]: %" PRId16 " -> %" PRId16, cur->str, sval,
                      cval);
         }
       }
       break;
       case FREERDP_SETTINGS_TYPE_UINT32: /* UINT32 */
       {
         UINT32 sval =
             freerdp_settings_get_uint32(settings, (FreeRDP_Settings_Keys_UInt32)cur->id);
         UINT32 cval =
             freerdp_settings_get_uint32(other, (FreeRDP_Settings_Keys_UInt32)cur->id);
         if (sval != cval)
         {
           rc = TRUE;
           WLog_Print(log, level, "%s [UINT32]: %" PRIu32 " -> %" PRIu32, cur->str, sval,
                      cval);
         }
       }
       break;
       case FREERDP_SETTINGS_TYPE_INT32: /* INT32 */
       {
         INT32 sval =
             freerdp_settings_get_int32(settings, (FreeRDP_Settings_Keys_Int32)cur->id);
         INT32 cval =
             freerdp_settings_get_int32(other, (FreeRDP_Settings_Keys_Int32)cur->id);
         if (sval != cval)
         {
           rc = TRUE;
           WLog_Print(log, level, "%s [INT32]: %" PRId32 " -> %" PRId32, cur->str, sval,
                      cval);
         }
       }
       break;
       case FREERDP_SETTINGS_TYPE_UINT64: /* UINT64 */
       {
         UINT64 sval =
             freerdp_settings_get_uint64(settings, (FreeRDP_Settings_Keys_UInt64)cur->id);
         UINT64 cval =
             freerdp_settings_get_uint64(other, (FreeRDP_Settings_Keys_UInt64)cur->id);
         if (sval != cval)
         {
           rc = TRUE;
           WLog_Print(log, level, "%s [UINT64]: %" PRIu64 " -> %" PRIu64, cur->str, sval,
                      cval);
         }
       }
       break;
       case FREERDP_SETTINGS_TYPE_INT64: /* INT64 */
       {
         INT64 sval =
             freerdp_settings_get_int64(settings, (FreeRDP_Settings_Keys_Int64)cur->id);
         INT64 cval =
             freerdp_settings_get_int64(other, (FreeRDP_Settings_Keys_Int64)cur->id);
         if (sval != cval)
         {
           rc = TRUE;
           WLog_Print(log, level, "%s [INT64]: %" PRId64 " -> %" PRId64, cur->str, sval,
                      cval);
         }
       }
       break;
       case FREERDP_SETTINGS_TYPE_STRING: /* strings */
       {
         const char* sval =
             freerdp_settings_get_string(settings, (FreeRDP_Settings_Keys_String)cur->id);
         const char* cval =
             freerdp_settings_get_string(other, (FreeRDP_Settings_Keys_String)cur->id);
         if (sval != cval)
         {
           if (!sval || !cval || (strcmp(sval, cval) != 0))
           {
             rc = TRUE;
             WLog_Print(log, level, "%s [STRING]: '%s' -> '%s'", cur->str, sval, cval);
           }
         }
       }
       break;
       case FREERDP_SETTINGS_TYPE_POINTER: /* pointer */
       {
         const void* sval =
             freerdp_settings_get_pointer(settings, (FreeRDP_Settings_Keys_Pointer)cur->id);
         const void* cval =
             freerdp_settings_get_pointer(other, (FreeRDP_Settings_Keys_Pointer)cur->id);
         if (sval != cval)
         {
           if ((sval && !cval) || (!sval && cval))
           {
             rc = TRUE;
             WLog_Print(log, level, "%s [POINTER]: '%p' -> '%p'", cur->str, sval, cval);
           }
         }
       }
       break;
     }
   }
   return rc;
 }

References freerdp_settings_get_bool(), freerdp_settings_get_int16(), freerdp_settings_get_int32(), freerdp_settings_get_int64(), freerdp_settings_get_pointer(), freerdp_settings_get_string(), freerdp_settings_get_uint16(), freerdp_settings_get_uint32(), and freerdp_settings_get_uint64().

Here is the call graph for this function:

◆ freerdp_settings_set_bool()

FREERDP_API BOOL freerdp_settings_set_bool	(	rdpSettings *	settings,
		FreeRDP_Settings_Keys_Bool	id,
		BOOL	param
	)

Sets a BOOL settings value.

Parameters

settings	A pointer to the settings to query, must not be NULL.
id	The key to query
param	The value to set.

Returns: TRUE for success, FALSE for failure

Definition at line 648 of file settings_getters.c.

 {
   union
   {
     void* v;
     const void* cv;
     BOOL c;
     const BOOL cc;
   } cnv;
   WINPR_ASSERT(settings);
  
   cnv.c = val;
  
   switch (id)
   {
     case FreeRDP_AadSecurity:
       settings->AadSecurity = cnv.c;
       break;
  
     case FreeRDP_AllowCacheWaitingList:
       settings->AllowCacheWaitingList = cnv.c;
       break;
  
     case FreeRDP_AllowDesktopComposition:
       settings->AllowDesktopComposition = cnv.c;
       break;
  
     case FreeRDP_AllowFontSmoothing:
       settings->AllowFontSmoothing = cnv.c;
       break;
  
     case FreeRDP_AllowUnanouncedOrdersFromServer:
       settings->AllowUnanouncedOrdersFromServer = cnv.c;
       break;
  
     case FreeRDP_AltSecFrameMarkerSupport:
       settings->AltSecFrameMarkerSupport = cnv.c;
       break;
  
     case FreeRDP_AsyncChannels:
       settings->AsyncChannels = cnv.c;
       break;
  
     case FreeRDP_AsyncUpdate:
       settings->AsyncUpdate = cnv.c;
       break;
  
     case FreeRDP_AudioCapture:
       settings->AudioCapture = cnv.c;
       break;
  
     case FreeRDP_AudioPlayback:
       settings->AudioPlayback = cnv.c;
       break;
  
     case FreeRDP_Authentication:
       settings->Authentication = cnv.c;
       break;
  
     case FreeRDP_AuthenticationOnly:
       settings->AuthenticationOnly = cnv.c;
       break;
  
     case FreeRDP_AutoAcceptCertificate:
       settings->AutoAcceptCertificate = cnv.c;
       break;
  
     case FreeRDP_AutoDenyCertificate:
       settings->AutoDenyCertificate = cnv.c;
       break;
  
     case FreeRDP_AutoLogonEnabled:
       settings->AutoLogonEnabled = cnv.c;
       break;
  
     case FreeRDP_AutoReconnectionEnabled:
       settings->AutoReconnectionEnabled = cnv.c;
       break;
  
     case FreeRDP_AutoReconnectionPacketSupported:
       settings->AutoReconnectionPacketSupported = cnv.c;
       break;
  
     case FreeRDP_BitmapCacheEnabled:
       settings->BitmapCacheEnabled = cnv.c;
       break;
  
     case FreeRDP_BitmapCachePersistEnabled:
       settings->BitmapCachePersistEnabled = cnv.c;
       break;
  
     case FreeRDP_BitmapCacheV3Enabled:
       settings->BitmapCacheV3Enabled = cnv.c;
       break;
  
     case FreeRDP_BitmapCompressionDisabled:
       settings->BitmapCompressionDisabled = cnv.c;
       break;
  
     case FreeRDP_CertificateCallbackPreferPEM:
       settings->CertificateCallbackPreferPEM = cnv.c;
       break;
  
     case FreeRDP_CompressionEnabled:
       settings->CompressionEnabled = cnv.c;
       break;
  
     case FreeRDP_ConnectChildSession:
       settings->ConnectChildSession = cnv.c;
       break;
  
     case FreeRDP_ConsoleSession:
       settings->ConsoleSession = cnv.c;
       break;
  
     case FreeRDP_CredentialsFromStdin:
       settings->CredentialsFromStdin = cnv.c;
       break;
  
     case FreeRDP_DeactivateClientDecoding:
       settings->DeactivateClientDecoding = cnv.c;
       break;
  
     case FreeRDP_Decorations:
       settings->Decorations = cnv.c;
       break;
  
     case FreeRDP_DesktopResize:
       settings->DesktopResize = cnv.c;
       break;
  
     case FreeRDP_DeviceRedirection:
       settings->DeviceRedirection = cnv.c;
       break;
  
     case FreeRDP_DisableCredentialsDelegation:
       settings->DisableCredentialsDelegation = cnv.c;
       break;
  
     case FreeRDP_DisableCtrlAltDel:
       settings->DisableCtrlAltDel = cnv.c;
       break;
  
     case FreeRDP_DisableCursorBlinking:
       settings->DisableCursorBlinking = cnv.c;
       break;
  
     case FreeRDP_DisableCursorShadow:
       settings->DisableCursorShadow = cnv.c;
       break;
  
     case FreeRDP_DisableFullWindowDrag:
       settings->DisableFullWindowDrag = cnv.c;
       break;
  
     case FreeRDP_DisableMenuAnims:
       settings->DisableMenuAnims = cnv.c;
       break;
  
     case FreeRDP_DisableRemoteAppCapsCheck:
       settings->DisableRemoteAppCapsCheck = cnv.c;
       break;
  
     case FreeRDP_DisableThemes:
       settings->DisableThemes = cnv.c;
       break;
  
     case FreeRDP_DisableWallpaper:
       settings->DisableWallpaper = cnv.c;
       break;
  
     case FreeRDP_DrawAllowColorSubsampling:
       settings->DrawAllowColorSubsampling = cnv.c;
       break;
  
     case FreeRDP_DrawAllowDynamicColorFidelity:
       settings->DrawAllowDynamicColorFidelity = cnv.c;
       break;
  
     case FreeRDP_DrawAllowSkipAlpha:
       settings->DrawAllowSkipAlpha = cnv.c;
       break;
  
     case FreeRDP_DrawGdiPlusCacheEnabled:
       settings->DrawGdiPlusCacheEnabled = cnv.c;
       break;
  
     case FreeRDP_DrawGdiPlusEnabled:
       settings->DrawGdiPlusEnabled = cnv.c;
       break;
  
     case FreeRDP_DrawNineGridEnabled:
       settings->DrawNineGridEnabled = cnv.c;
       break;
  
     case FreeRDP_DumpRemoteFx:
       settings->DumpRemoteFx = cnv.c;
       break;
  
     case FreeRDP_DynamicDaylightTimeDisabled:
       settings->DynamicDaylightTimeDisabled = cnv.c;
       break;
  
     case FreeRDP_DynamicResolutionUpdate:
       settings->DynamicResolutionUpdate = cnv.c;
       break;
  
     case FreeRDP_EmbeddedWindow:
       settings->EmbeddedWindow = cnv.c;
       break;
  
     case FreeRDP_EnableWindowsKey:
       settings->EnableWindowsKey = cnv.c;
       break;
  
     case FreeRDP_EncomspVirtualChannel:
       settings->EncomspVirtualChannel = cnv.c;
       break;
  
     case FreeRDP_ExtSecurity:
       settings->ExtSecurity = cnv.c;
       break;
  
     case FreeRDP_ExternalCertificateManagement:
       settings->ExternalCertificateManagement = cnv.c;
       break;
  
     case FreeRDP_FIPSMode:
       settings->FIPSMode = cnv.c;
       break;
  
     case FreeRDP_FastPathInput:
       settings->FastPathInput = cnv.c;
       break;
  
     case FreeRDP_FastPathOutput:
       settings->FastPathOutput = cnv.c;
       break;
  
     case FreeRDP_ForceEncryptedCsPdu:
       settings->ForceEncryptedCsPdu = cnv.c;
       break;
  
     case FreeRDP_ForceMultimon:
       settings->ForceMultimon = cnv.c;
       break;
  
     case FreeRDP_FrameMarkerCommandEnabled:
       settings->FrameMarkerCommandEnabled = cnv.c;
       break;
  
     case FreeRDP_Fullscreen:
       settings->Fullscreen = cnv.c;
       break;
  
     case FreeRDP_GatewayArmTransport:
       settings->GatewayArmTransport = cnv.c;
       break;
  
     case FreeRDP_GatewayBypassLocal:
       settings->GatewayBypassLocal = cnv.c;
       break;
  
     case FreeRDP_GatewayEnabled:
       settings->GatewayEnabled = cnv.c;
       break;
  
     case FreeRDP_GatewayHttpExtAuthSspiNtlm:
       settings->GatewayHttpExtAuthSspiNtlm = cnv.c;
       break;
  
     case FreeRDP_GatewayHttpTransport:
       settings->GatewayHttpTransport = cnv.c;
       break;
  
     case FreeRDP_GatewayHttpUseWebsockets:
       settings->GatewayHttpUseWebsockets = cnv.c;
       break;
  
     case FreeRDP_GatewayIgnoreRedirectionPolicy:
       settings->GatewayIgnoreRedirectionPolicy = cnv.c;
       break;
  
     case FreeRDP_GatewayRpcTransport:
       settings->GatewayRpcTransport = cnv.c;
       break;
  
     case FreeRDP_GatewayUdpTransport:
       settings->GatewayUdpTransport = cnv.c;
       break;
  
     case FreeRDP_GatewayUseSameCredentials:
       settings->GatewayUseSameCredentials = cnv.c;
       break;
  
     case FreeRDP_GfxAVC444:
       settings->GfxAVC444 = cnv.c;
       break;
  
     case FreeRDP_GfxAVC444v2:
       settings->GfxAVC444v2 = cnv.c;
       break;
  
     case FreeRDP_GfxH264:
       settings->GfxH264 = cnv.c;
       break;
  
     case FreeRDP_GfxPlanar:
       settings->GfxPlanar = cnv.c;
       break;
  
     case FreeRDP_GfxProgressive:
       settings->GfxProgressive = cnv.c;
       break;
  
     case FreeRDP_GfxProgressiveV2:
       settings->GfxProgressiveV2 = cnv.c;
       break;
  
     case FreeRDP_GfxSendQoeAck:
       settings->GfxSendQoeAck = cnv.c;
       break;
  
     case FreeRDP_GfxSmallCache:
       settings->GfxSmallCache = cnv.c;
       break;
  
     case FreeRDP_GfxSuspendFrameAck:
       settings->GfxSuspendFrameAck = cnv.c;
       break;
  
     case FreeRDP_GfxThinClient:
       settings->GfxThinClient = cnv.c;
       break;
  
     case FreeRDP_GrabKeyboard:
       settings->GrabKeyboard = cnv.c;
       break;
  
     case FreeRDP_GrabMouse:
       settings->GrabMouse = cnv.c;
       break;
  
     case FreeRDP_HasExtendedMouseEvent:
       settings->HasExtendedMouseEvent = cnv.c;
       break;
  
     case FreeRDP_HasHorizontalWheel:
       settings->HasHorizontalWheel = cnv.c;
       break;
  
     case FreeRDP_HasMonitorAttributes:
       settings->HasMonitorAttributes = cnv.c;
       break;
  
     case FreeRDP_HasQoeEvent:
       settings->HasQoeEvent = cnv.c;
       break;
  
     case FreeRDP_HasRelativeMouseEvent:
       settings->HasRelativeMouseEvent = cnv.c;
       break;
  
     case FreeRDP_HiDefRemoteApp:
       settings->HiDefRemoteApp = cnv.c;
       break;
  
     case FreeRDP_IPv6Enabled:
       settings->IPv6Enabled = cnv.c;
       break;
  
     case FreeRDP_IgnoreCertificate:
       settings->IgnoreCertificate = cnv.c;
       break;
  
     case FreeRDP_IgnoreInvalidDevices:
       settings->IgnoreInvalidDevices = cnv.c;
       break;
  
     case FreeRDP_JpegCodec:
       settings->JpegCodec = cnv.c;
       break;
  
     case FreeRDP_KerberosRdgIsProxy:
       settings->KerberosRdgIsProxy = cnv.c;
       break;
  
     case FreeRDP_ListMonitors:
       settings->ListMonitors = cnv.c;
       break;
  
     case FreeRDP_LocalConnection:
       settings->LocalConnection = cnv.c;
       break;
  
     case FreeRDP_LogonErrors:
       settings->LogonErrors = cnv.c;
       break;
  
     case FreeRDP_LogonNotify:
       settings->LogonNotify = cnv.c;
       break;
  
     case FreeRDP_LongCredentialsSupported:
       settings->LongCredentialsSupported = cnv.c;
       break;
  
     case FreeRDP_LyncRdpMode:
       settings->LyncRdpMode = cnv.c;
       break;
  
     case FreeRDP_MaximizeShell:
       settings->MaximizeShell = cnv.c;
       break;
  
     case FreeRDP_MouseAttached:
       settings->MouseAttached = cnv.c;
       break;
  
     case FreeRDP_MouseHasWheel:
       settings->MouseHasWheel = cnv.c;
       break;
  
     case FreeRDP_MouseMotion:
       settings->MouseMotion = cnv.c;
       break;
  
     case FreeRDP_MouseUseRelativeMove:
       settings->MouseUseRelativeMove = cnv.c;
       break;
  
     case FreeRDP_MstscCookieMode:
       settings->MstscCookieMode = cnv.c;
       break;
  
     case FreeRDP_MultiTouchGestures:
       settings->MultiTouchGestures = cnv.c;
       break;
  
     case FreeRDP_MultiTouchInput:
       settings->MultiTouchInput = cnv.c;
       break;
  
     case FreeRDP_NSCodec:
       settings->NSCodec = cnv.c;
       break;
  
     case FreeRDP_NSCodecAllowDynamicColorFidelity:
       settings->NSCodecAllowDynamicColorFidelity = cnv.c;
       break;
  
     case FreeRDP_NSCodecAllowSubsampling:
       settings->NSCodecAllowSubsampling = cnv.c;
       break;
  
     case FreeRDP_NegotiateSecurityLayer:
       settings->NegotiateSecurityLayer = cnv.c;
       break;
  
     case FreeRDP_NetworkAutoDetect:
       settings->NetworkAutoDetect = cnv.c;
       break;
  
     case FreeRDP_NlaSecurity:
       settings->NlaSecurity = cnv.c;
       break;
  
     case FreeRDP_NoBitmapCompressionHeader:
       settings->NoBitmapCompressionHeader = cnv.c;
       break;
  
     case FreeRDP_OldLicenseBehaviour:
       settings->OldLicenseBehaviour = cnv.c;
       break;
  
     case FreeRDP_PasswordIsSmartcardPin:
       settings->PasswordIsSmartcardPin = cnv.c;
       break;
  
     case FreeRDP_PercentScreenUseHeight:
       settings->PercentScreenUseHeight = cnv.c;
       break;
  
     case FreeRDP_PercentScreenUseWidth:
       settings->PercentScreenUseWidth = cnv.c;
       break;
  
     case FreeRDP_PlayRemoteFx:
       settings->PlayRemoteFx = cnv.c;
       break;
  
     case FreeRDP_PreferIPv6OverIPv4:
       settings->PreferIPv6OverIPv4 = cnv.c;
       break;
  
     case FreeRDP_PrintReconnectCookie:
       settings->PrintReconnectCookie = cnv.c;
       break;
  
     case FreeRDP_PromptForCredentials:
       settings->PromptForCredentials = cnv.c;
       break;
  
     case FreeRDP_RdpSecurity:
       settings->RdpSecurity = cnv.c;
       break;
  
     case FreeRDP_RdstlsSecurity:
       settings->RdstlsSecurity = cnv.c;
       break;
  
     case FreeRDP_RedirectClipboard:
       settings->RedirectClipboard = cnv.c;
       break;
  
     case FreeRDP_RedirectDrives:
       settings->RedirectDrives = cnv.c;
       break;
  
     case FreeRDP_RedirectHomeDrive:
       settings->RedirectHomeDrive = cnv.c;
       break;
  
     case FreeRDP_RedirectParallelPorts:
       settings->RedirectParallelPorts = cnv.c;
       break;
  
     case FreeRDP_RedirectPrinters:
       settings->RedirectPrinters = cnv.c;
       break;
  
     case FreeRDP_RedirectSerialPorts:
       settings->RedirectSerialPorts = cnv.c;
       break;
  
     case FreeRDP_RedirectSmartCards:
       settings->RedirectSmartCards = cnv.c;
       break;
  
     case FreeRDP_RedirectWebAuthN:
       settings->RedirectWebAuthN = cnv.c;
       break;
  
     case FreeRDP_RefreshRect:
       settings->RefreshRect = cnv.c;
       break;
  
     case FreeRDP_RemdeskVirtualChannel:
       settings->RemdeskVirtualChannel = cnv.c;
       break;
  
     case FreeRDP_RemoteAppLanguageBarSupported:
       settings->RemoteAppLanguageBarSupported = cnv.c;
       break;
  
     case FreeRDP_RemoteApplicationMode:
       settings->RemoteApplicationMode = cnv.c;
       break;
  
     case FreeRDP_RemoteAssistanceMode:
       settings->RemoteAssistanceMode = cnv.c;
       break;
  
     case FreeRDP_RemoteAssistanceRequestControl:
       settings->RemoteAssistanceRequestControl = cnv.c;
       break;
  
     case FreeRDP_RemoteConsoleAudio:
       settings->RemoteConsoleAudio = cnv.c;
       break;
  
     case FreeRDP_RemoteCredentialGuard:
       settings->RemoteCredentialGuard = cnv.c;
       break;
  
     case FreeRDP_RemoteFxCodec:
       settings->RemoteFxCodec = cnv.c;
       break;
  
     case FreeRDP_RemoteFxImageCodec:
       settings->RemoteFxImageCodec = cnv.c;
       break;
  
     case FreeRDP_RemoteFxOnly:
       settings->RemoteFxOnly = cnv.c;
       break;
  
     case FreeRDP_RestrictedAdminModeRequired:
       settings->RestrictedAdminModeRequired = cnv.c;
       break;
  
     case FreeRDP_SaltedChecksum:
       settings->SaltedChecksum = cnv.c;
       break;
  
     case FreeRDP_SendPreconnectionPdu:
       settings->SendPreconnectionPdu = cnv.c;
       break;
  
     case FreeRDP_ServerLicenseRequired:
       settings->ServerLicenseRequired = cnv.c;
       break;
  
     case FreeRDP_ServerMode:
       settings->ServerMode = cnv.c;
       break;
  
     case FreeRDP_SmartSizing:
       settings->SmartSizing = cnv.c;
       break;
  
     case FreeRDP_SmartcardEmulation:
       settings->SmartcardEmulation = cnv.c;
       break;
  
     case FreeRDP_SmartcardLogon:
       settings->SmartcardLogon = cnv.c;
       break;
  
     case FreeRDP_SoftwareGdi:
       settings->SoftwareGdi = cnv.c;
       break;
  
     case FreeRDP_SoundBeepsEnabled:
       settings->SoundBeepsEnabled = cnv.c;
       break;
  
     case FreeRDP_SpanMonitors:
       settings->SpanMonitors = cnv.c;
       break;
  
     case FreeRDP_SupportAsymetricKeys:
       settings->SupportAsymetricKeys = cnv.c;
       break;
  
     case FreeRDP_SupportDisplayControl:
       settings->SupportDisplayControl = cnv.c;
       break;
  
     case FreeRDP_SupportDynamicChannels:
       settings->SupportDynamicChannels = cnv.c;
       break;
  
     case FreeRDP_SupportDynamicTimeZone:
       settings->SupportDynamicTimeZone = cnv.c;
       break;
  
     case FreeRDP_SupportEchoChannel:
       settings->SupportEchoChannel = cnv.c;
       break;
  
     case FreeRDP_SupportEdgeActionV1:
       settings->SupportEdgeActionV1 = cnv.c;
       break;
  
     case FreeRDP_SupportEdgeActionV2:
       settings->SupportEdgeActionV2 = cnv.c;
       break;
  
     case FreeRDP_SupportErrorInfoPdu:
       settings->SupportErrorInfoPdu = cnv.c;
       break;
  
     case FreeRDP_SupportGeometryTracking:
       settings->SupportGeometryTracking = cnv.c;
       break;
  
     case FreeRDP_SupportGraphicsPipeline:
       settings->SupportGraphicsPipeline = cnv.c;
       break;
  
     case FreeRDP_SupportHeartbeatPdu:
       settings->SupportHeartbeatPdu = cnv.c;
       break;
  
     case FreeRDP_SupportMonitorLayoutPdu:
       settings->SupportMonitorLayoutPdu = cnv.c;
       break;
  
     case FreeRDP_SupportMultitransport:
       settings->SupportMultitransport = cnv.c;
       break;
  
     case FreeRDP_SupportSSHAgentChannel:
       settings->SupportSSHAgentChannel = cnv.c;
       break;
  
     case FreeRDP_SupportSkipChannelJoin:
       settings->SupportSkipChannelJoin = cnv.c;
       break;
  
     case FreeRDP_SupportStatusInfoPdu:
       settings->SupportStatusInfoPdu = cnv.c;
       break;
  
     case FreeRDP_SupportVideoOptimized:
       settings->SupportVideoOptimized = cnv.c;
       break;
  
     case FreeRDP_SuppressOutput:
       settings->SuppressOutput = cnv.c;
       break;
  
     case FreeRDP_SurfaceCommandsEnabled:
       settings->SurfaceCommandsEnabled = cnv.c;
       break;
  
     case FreeRDP_SurfaceFrameMarkerEnabled:
       settings->SurfaceFrameMarkerEnabled = cnv.c;
       break;
  
     case FreeRDP_SuspendInput:
       settings->SuspendInput = cnv.c;
       break;
  
     case FreeRDP_SynchronousDynamicChannels:
       settings->SynchronousDynamicChannels = cnv.c;
       break;
  
     case FreeRDP_SynchronousStaticChannels:
       settings->SynchronousStaticChannels = cnv.c;
       break;
  
     case FreeRDP_TcpKeepAlive:
       settings->TcpKeepAlive = cnv.c;
       break;
  
     case FreeRDP_TlsSecurity:
       settings->TlsSecurity = cnv.c;
       break;
  
     case FreeRDP_ToggleFullscreen:
       settings->ToggleFullscreen = cnv.c;
       break;
  
     case FreeRDP_TransportDump:
       settings->TransportDump = cnv.c;
       break;
  
     case FreeRDP_TransportDumpReplay:
       settings->TransportDumpReplay = cnv.c;
       break;
  
     case FreeRDP_TransportDumpReplayNodelay:
       settings->TransportDumpReplayNodelay = cnv.c;
       break;
  
     case FreeRDP_UnicodeInput:
       settings->UnicodeInput = cnv.c;
       break;
  
     case FreeRDP_UnmapButtons:
       settings->UnmapButtons = cnv.c;
       break;
  
     case FreeRDP_UseCommonStdioCallbacks:
       settings->UseCommonStdioCallbacks = cnv.c;
       break;
  
     case FreeRDP_UseMultimon:
       settings->UseMultimon = cnv.c;
       break;
  
     case FreeRDP_UseRdpSecurityLayer:
       settings->UseRdpSecurityLayer = cnv.c;
       break;
  
     case FreeRDP_UsingSavedCredentials:
       settings->UsingSavedCredentials = cnv.c;
       break;
  
     case FreeRDP_VideoDisable:
       settings->VideoDisable = cnv.c;
       break;
  
     case FreeRDP_VmConnectMode:
       settings->VmConnectMode = cnv.c;
       break;
  
     case FreeRDP_WaitForOutputBufferFlush:
       settings->WaitForOutputBufferFlush = cnv.c;
       break;
  
     case FreeRDP_Workarea:
       settings->Workarea = cnv.c;
       break;
  
     default:
       WLog_ERR(TAG, "Invalid key index %" PRIuz " [%s|%s]", id,
                freerdp_settings_get_name_for_key(id),
                freerdp_settings_get_type_name_for_key(id));
       return FALSE;
   }
   return TRUE;
 }

References freerdp_settings_get_name_for_key(), and freerdp_settings_get_type_name_for_key().

Referenced by freerdp_settings_copy_item().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ freerdp_settings_set_int16()

FREERDP_API BOOL freerdp_settings_set_int16	(	rdpSettings *	settings,
		FreeRDP_Settings_Keys_Int16	id,
		INT16	param
	)

Sets a INT16 settings value.

Parameters

settings	A pointer to the settings to query, must not be NULL.
id	The key to query
param	The value to set.

Returns: TRUE for success, FALSE for failure

Definition at line 1589 of file settings_getters.c.

 {
   union
   {
     void* v;
     const void* cv;
     INT16 c;
     const INT16 cc;
   } cnv;
   WINPR_ASSERT(settings);
  
   cnv.c = val;
  
   switch (id)
   {
     default:
       WLog_ERR(TAG, "Invalid key index %" PRIuz " [%s|%s]", id,
                freerdp_settings_get_name_for_key(id),
                freerdp_settings_get_type_name_for_key(id));
       return FALSE;
   }
   return TRUE;
 }

References freerdp_settings_get_name_for_key(), and freerdp_settings_get_type_name_for_key().

Referenced by freerdp_settings_copy_item().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ freerdp_settings_set_int32()

FREERDP_API BOOL freerdp_settings_set_int32	(	rdpSettings *	settings,
		FreeRDP_Settings_Keys_Int32	id,
		INT32	param
	)

Sets a INT32 settings value.

Parameters

settings	A pointer to the settings to query, must not be NULL.
id	The key to query
param	The value to set.

Returns: TRUE for success, FALSE for failure

Definition at line 2555 of file settings_getters.c.

 {
   union
   {
     void* v;
     const void* cv;
     INT32 c;
     const INT32 cc;
   } cnv;
   WINPR_ASSERT(settings);
  
   cnv.c = val;
  
   switch (id)
   {
     case FreeRDP_XPan:
       settings->XPan = cnv.c;
       break;
  
     case FreeRDP_YPan:
       settings->YPan = cnv.c;
       break;
  
     default:
       WLog_ERR(TAG, "Invalid key index %" PRIuz " [%s|%s]", id,
                freerdp_settings_get_name_for_key(id),
                freerdp_settings_get_type_name_for_key(id));
       return FALSE;
   }
   return TRUE;
 }

References freerdp_settings_get_name_for_key(), and freerdp_settings_get_type_name_for_key().

Referenced by freerdp_settings_copy_item().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ freerdp_settings_set_int64()

FREERDP_API BOOL freerdp_settings_set_int64	(	rdpSettings *	settings,
		FreeRDP_Settings_Keys_Int64	id,
		INT64	param
	)

Sets a INT64 settings value.

Parameters

settings	A pointer to the settings to query, must not be NULL.
id	The key to query
param	The value to set.

Returns: TRUE for success, FALSE for failure

Definition at line 2648 of file settings_getters.c.

 {
   union
   {
     void* v;
     const void* cv;
     INT64 c;
     const INT64 cc;
   } cnv;
   WINPR_ASSERT(settings);
  
   cnv.c = val;
  
   switch (id)
   {
     default:
       WLog_ERR(TAG, "Invalid key index %" PRIuz " [%s|%s]", id,
                freerdp_settings_get_name_for_key(id),
                freerdp_settings_get_type_name_for_key(id));
       return FALSE;
   }
   return TRUE;
 }

References freerdp_settings_get_name_for_key(), and freerdp_settings_get_type_name_for_key().

Referenced by freerdp_settings_copy_item().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ freerdp_settings_set_pointer()

FREERDP_API BOOL freerdp_settings_set_pointer	(	rdpSettings *	settings,
		FreeRDP_Settings_Keys_Pointer	id,
		const void *	data
	)

Set a pointer to value data.

Parameters

settings	A pointer to the settings to query, must not be NULL.
id	The key to update
data	The data to set (direct update, no copy created, previous value overwritten)

Returns: TRUE for success, FALSE for failure

Definition at line 4057 of file settings_getters.c.

 {
   union
   {
     void* v;
     const void* cv;
   } cnv;
   WINPR_ASSERT(settings);
  
   cnv.cv = val;
  
   switch (id)
   {
     case FreeRDP_BitmapCacheV2CellInfo:
       settings->BitmapCacheV2CellInfo = cnv.v;
       break;
  
     case FreeRDP_ChannelDefArray:
       settings->ChannelDefArray = cnv.v;
       break;
  
     case FreeRDP_ClientAutoReconnectCookie:
       settings->ClientAutoReconnectCookie = cnv.v;
       break;
  
     case FreeRDP_ClientRandom:
       settings->ClientRandom = cnv.v;
       break;
  
     case FreeRDP_ClientTimeZone:
       settings->ClientTimeZone = cnv.v;
       break;
  
     case FreeRDP_DeviceArray:
       settings->DeviceArray = cnv.v;
       break;
  
     case FreeRDP_DynamicChannelArray:
       settings->DynamicChannelArray = cnv.v;
       break;
  
     case FreeRDP_FragCache:
       settings->FragCache = cnv.v;
       break;
  
     case FreeRDP_GlyphCache:
       settings->GlyphCache = cnv.v;
       break;
  
     case FreeRDP_LoadBalanceInfo:
       settings->LoadBalanceInfo = cnv.v;
       break;
  
     case FreeRDP_MonitorDefArray:
       settings->MonitorDefArray = cnv.v;
       break;
  
     case FreeRDP_MonitorIds:
       settings->MonitorIds = cnv.v;
       break;
  
     case FreeRDP_OrderSupport:
       settings->OrderSupport = cnv.v;
       break;
  
     case FreeRDP_Password51:
       settings->Password51 = cnv.v;
       break;
  
     case FreeRDP_RdpServerCertificate:
       settings->RdpServerCertificate = cnv.v;
       break;
  
     case FreeRDP_RdpServerRsaKey:
       settings->RdpServerRsaKey = cnv.v;
       break;
  
     case FreeRDP_ReceivedCapabilities:
       settings->ReceivedCapabilities = cnv.v;
       break;
  
     case FreeRDP_ReceivedCapabilityData:
       settings->ReceivedCapabilityData = cnv.v;
       break;
  
     case FreeRDP_ReceivedCapabilityDataSizes:
       settings->ReceivedCapabilityDataSizes = cnv.v;
       break;
  
     case FreeRDP_RedirectionGuid:
       settings->RedirectionGuid = cnv.v;
       break;
  
     case FreeRDP_RedirectionPassword:
       settings->RedirectionPassword = cnv.v;
       break;
  
     case FreeRDP_RedirectionTargetCertificate:
       settings->RedirectionTargetCertificate = cnv.v;
       break;
  
     case FreeRDP_RedirectionTsvUrl:
       settings->RedirectionTsvUrl = cnv.v;
       break;
  
     case FreeRDP_ServerAutoReconnectCookie:
       settings->ServerAutoReconnectCookie = cnv.v;
       break;
  
     case FreeRDP_ServerCertificate:
       settings->ServerCertificate = cnv.v;
       break;
  
     case FreeRDP_ServerLicenseProductIssuers:
       settings->ServerLicenseProductIssuers = cnv.v;
       break;
  
     case FreeRDP_ServerRandom:
       settings->ServerRandom = cnv.v;
       break;
  
     case FreeRDP_StaticChannelArray:
       settings->StaticChannelArray = cnv.v;
       break;
  
     case FreeRDP_TargetNetAddresses:
       settings->TargetNetAddresses = cnv.v;
       break;
  
     case FreeRDP_TargetNetPorts:
       settings->TargetNetPorts = cnv.v;
       break;
  
     case FreeRDP_instance:
       settings->instance = cnv.v;
       break;
  
     default:
       WLog_ERR(TAG, "Invalid key index %" PRIuz " [%s|%s]", id,
                freerdp_settings_get_name_for_key(id),
                freerdp_settings_get_type_name_for_key(id));
       return FALSE;
   }
   return TRUE;
 }

References freerdp_settings_get_name_for_key(), and freerdp_settings_get_type_name_for_key().

Referenced by freerdp_settings_copy_item().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ freerdp_settings_set_pointer_len()

FREERDP_API BOOL freerdp_settings_set_pointer_len	(	rdpSettings *	settings,
		FreeRDP_Settings_Keys_Pointer	id,
		const void *	data,
		size_t	len
	)

Set a pointer to value data.

Parameters

settings	A pointer to the settings to query, must not be NULL.
id	The key to update
data	The data to set (copy created, previous value freed)

Returns: TRUE for success, FALSE for failure

Definition at line 1305 of file common/settings.c.

 {
   union
   {
     const void* cv;
     void* v;
   } cnv;
  
   cnv.cv = data;
   if (!settings)
     return FALSE;
  
   switch (id)
   {
     case FreeRDP_RdpServerCertificate:
       freerdp_certificate_free(settings->RdpServerCertificate);
  
       if (len > 1)
       {
         WLog_ERR(TAG, "FreeRDP_RdpServerCertificate::len must be 0 or 1");
         return FALSE;
       }
       settings->RdpServerCertificate = cnv.v;
       if (!settings->RdpServerCertificate && (len > 0))
       {
         settings->RdpServerCertificate = freerdp_certificate_new();
         if (!settings->RdpServerCertificate)
           return FALSE;
       }
       return TRUE;
     case FreeRDP_RdpServerRsaKey:
       freerdp_key_free(settings->RdpServerRsaKey);
       if (len > 1)
       {
         WLog_ERR(TAG, "FreeRDP_RdpServerRsaKey::len must be 0 or 1");
         return FALSE;
       }
       settings->RdpServerRsaKey = (rdpPrivateKey*)cnv.v;
       if (!settings->RdpServerRsaKey && (len > 0))
       {
         settings->RdpServerRsaKey = freerdp_key_new();
         if (!settings->RdpServerRsaKey)
           return FALSE;
       }
       return TRUE;
     case FreeRDP_RedirectionPassword:
       return freerdp_settings_set_pointer_len_(
           settings, id, FreeRDP_RedirectionPasswordLength, data, len, sizeof(char));
     case FreeRDP_RedirectionTsvUrl:
       return freerdp_settings_set_pointer_len_(settings, id, FreeRDP_RedirectionTsvUrlLength,
                                                data, len, sizeof(char));
     case FreeRDP_RedirectionTargetCertificate:
       freerdp_certificate_free(settings->RedirectionTargetCertificate);
  
       if (len > 1)
       {
         WLog_ERR(TAG, "FreeRDP_RedirectionTargetCertificate::len must be 0 or 1");
         return FALSE;
       }
       settings->RedirectionTargetCertificate = cnv.v;
       if (!settings->RedirectionTargetCertificate && (len > 0))
       {
         settings->RedirectionTargetCertificate = freerdp_certificate_new();
         if (!settings->RedirectionTargetCertificate)
           return FALSE;
       }
       return TRUE;
     case FreeRDP_RedirectionGuid:
       return freerdp_settings_set_pointer_len_(settings, id, FreeRDP_RedirectionGuidLength,
                                                data, len, sizeof(BYTE));
     case FreeRDP_LoadBalanceInfo:
       return freerdp_settings_set_pointer_len_(settings, id, FreeRDP_LoadBalanceInfoLength,
                                                data, len, sizeof(char));
     case FreeRDP_ServerRandom:
       return freerdp_settings_set_pointer_len_(settings, id, FreeRDP_ServerRandomLength, data,
                                                len, sizeof(char));
     case FreeRDP_ClientRandom:
       return freerdp_settings_set_pointer_len_(settings, id, FreeRDP_ClientRandomLength, data,
                                                len, sizeof(char));
     case FreeRDP_ServerCertificate:
       return freerdp_settings_set_pointer_len_(settings, id, FreeRDP_ServerCertificateLength,
                                                data, len, sizeof(char));
     case FreeRDP_TargetNetAddresses:
       if ((data == NULL) && (len == 0))
       {
         freerdp_target_net_addresses_free(settings);
         return TRUE;
       }
       WLog_WARN(
           TAG,
           "[BUG] FreeRDP_TargetNetAddresses must not be resized from outside the library!");
       return FALSE;
     case FreeRDP_ServerLicenseProductIssuers:
       if (data == NULL)
         freerdp_server_license_issuers_free(settings);
       return freerdp_settings_set_pointer_len_(settings, FreeRDP_ServerLicenseProductIssuers,
                                                FreeRDP_ServerLicenseProductIssuersCount, data,
                                                len, sizeof(char*));
     case FreeRDP_TargetNetPorts:
       if ((data == NULL) && (len == 0))
       {
         freerdp_target_net_addresses_free(settings);
         return TRUE;
       }
       WLog_WARN(TAG,
                 "[BUG] FreeRDP_TargetNetPorts must not be resized from outside the library!");
       return FALSE;
     case FreeRDP_DeviceArray:
       if (data == NULL)
         freerdp_device_collection_free(settings);
       return freerdp_settings_set_pointer_len_(settings, id, FreeRDP_DeviceArraySize, data,
                                                len, sizeof(ADDIN_ARGV*));
     case FreeRDP_ChannelDefArray:
       if ((len > 0) && (len < CHANNEL_MAX_COUNT))
         WLog_WARN(TAG,
                   "FreeRDP_ChannelDefArray::len expected to be >= %" PRIu32
                   ", but have %" PRIu32,
                   CHANNEL_MAX_COUNT, len);
       return freerdp_settings_set_pointer_len_(settings, FreeRDP_ChannelDefArray,
                                                FreeRDP_ChannelDefArraySize, data, len,
                                                sizeof(CHANNEL_DEF));
     case FreeRDP_MonitorDefArray:
       return freerdp_settings_set_pointer_len_(settings, id, FreeRDP_MonitorDefArraySize,
                                                data, len, sizeof(rdpMonitor));
     case FreeRDP_ClientAutoReconnectCookie:
       return freerdp_settings_set_pointer_len_(settings, id, -1, data, len,
                                                sizeof(ARC_CS_PRIVATE_PACKET));
     case FreeRDP_ServerAutoReconnectCookie:
       return freerdp_settings_set_pointer_len_(settings, id, -1, data, len,
                                                sizeof(ARC_SC_PRIVATE_PACKET));
     case FreeRDP_ClientTimeZone:
       if (len > 1)
       {
         WLog_ERR(TAG, "FreeRDP_ClientTimeZone::len must be 0 or 1");
         return FALSE;
       }
       return freerdp_settings_set_pointer_len_(settings, id, -1, data, len,
                                                sizeof(TIME_ZONE_INFORMATION));
     case FreeRDP_BitmapCacheV2CellInfo:
       return freerdp_settings_set_pointer_len_(settings, id, FreeRDP_BitmapCacheV2NumCells,
                                                data, len, sizeof(BITMAP_CACHE_V2_CELL_INFO));
     case FreeRDP_GlyphCache:
       if ((len != 0) && (len != 10))
       {
         WLog_ERR(TAG, "FreeRDP_GlyphCache::len must be 0 or 10");
         return FALSE;
       }
       return freerdp_settings_set_pointer_len_(settings, id, -1, data, len,
                                                sizeof(GLYPH_CACHE_DEFINITION));
     case FreeRDP_FragCache:
       if (len > 1)
       {
         WLog_ERR(TAG, "FreeRDP_FragCache::len must be 0 or 1");
         return FALSE;
       }
       return freerdp_settings_set_pointer_len_(settings, id, -1, data, len,
                                                sizeof(GLYPH_CACHE_DEFINITION));
     case FreeRDP_StaticChannelArray:
       if (data == NULL)
         freerdp_static_channel_collection_free(settings);
       return freerdp_settings_set_pointer_len_(settings, id, FreeRDP_StaticChannelArraySize,
                                                data, len, sizeof(ADDIN_ARGV*));
     case FreeRDP_DynamicChannelArray:
       if (data == NULL)
         freerdp_dynamic_channel_collection_free(settings);
       return freerdp_settings_set_pointer_len_(settings, id, FreeRDP_DynamicChannelArraySize,
                                                data, len, sizeof(ADDIN_ARGV*));
     case FreeRDP_ReceivedCapabilityData:
       if (data == NULL)
         freerdp_capability_buffer_free(settings);
       return freerdp_settings_set_pointer_len_(settings, id, FreeRDP_ReceivedCapabilitiesSize,
                                                data, len, sizeof(BYTE*));
     case FreeRDP_ReceivedCapabilities:
       if (data == NULL)
         freerdp_capability_buffer_free(settings);
       return freerdp_settings_set_pointer_len_(settings, id, FreeRDP_ReceivedCapabilitiesSize,
                                                data, len, sizeof(char));
     case FreeRDP_OrderSupport:
       return freerdp_settings_set_pointer_len_(settings, id, -1, data, len, sizeof(char));
  
     case FreeRDP_MonitorIds:
       return freerdp_settings_set_pointer_len_(
           settings, FreeRDP_MonitorIds, FreeRDP_NumMonitorIds, data, len, sizeof(UINT32));
  
     default:
       if ((data == NULL) && (len == 0))
       {
         freerdp_settings_set_pointer(settings, id, NULL);
       }
       else
         WLog_WARN(TAG, "Invalid id %" PRIuz, id);
       return FALSE;
   }
 }

◆ freerdp_settings_set_string()

FREERDP_API BOOL freerdp_settings_set_string	(	rdpSettings *	settings,
		FreeRDP_Settings_Keys_String	id,
		const char *	param
	)

Sets a string settings value. The param is copied.

Parameters

settings	A pointer to the settings to query, must not be NULL.
id	The key to query
param	The value to set. If NULL removes the old entry, otherwise a copy is created.

Returns: TRUE for success, FALSE for failure

Definition at line 3616 of file settings_getters.c.

 {
   size_t len = 0;
   if (val)
     len = strlen(val);
   return freerdp_settings_set_string_copy_(settings, id, val, len, TRUE);
 }

Referenced by freerdp_settings_copy_item().

Here is the caller graph for this function:

◆ freerdp_settings_set_string_from_utf16()

FREERDP_API BOOL freerdp_settings_set_string_from_utf16	(	rdpSettings *	settings,
		FreeRDP_Settings_Keys_String	id,
		const WCHAR *	param
	)

Sets a string settings value. The param is converted to UTF-8 and the copy stored.

Parameters

settings	A pointer to the settings to query, must not be NULL.
id	The key to query
param	The value to set. If NULL removes the old entry, otherwise a copy is created.

Returns: TRUE for success, FALSE for failure

Definition at line 2054 of file common/settings.c.

 {
   WINPR_ASSERT(settings);
  
   if (!param)
     return freerdp_settings_set_string_copy_(settings, id, NULL, 0, TRUE);
  
   size_t len = 0;
  
   char* str = ConvertWCharToUtf8Alloc(param, &len);
   if (!str && (len != 0))
     return FALSE;
  
   return freerdp_settings_set_string_(settings, id, str, len);
 }

◆ freerdp_settings_set_string_from_utf16N()

FREERDP_API BOOL freerdp_settings_set_string_from_utf16N	(	rdpSettings *	settings,
		FreeRDP_Settings_Keys_String	id,
		const WCHAR *	param,
		size_t	length
	)

Sets a string settings value. The param is converted to UTF-8 and the copy stored.

Parameters

settings	A pointer to the settings to query, must not be NULL.
id	The key to query
param	The value to set. If NULL removes the old entry, otherwise a copy is created.
length	The length of the WCHAR string in number of WCHAR characters

Returns: TRUE for success, FALSE for failure

Definition at line 2071 of file common/settings.c.

 {
   size_t len = 0;
  
   WINPR_ASSERT(settings);
  
   if (!param)
     return freerdp_settings_set_string_copy_(settings, id, NULL, length, TRUE);
  
   char* str = ConvertWCharNToUtf8Alloc(param, length, &len);
   if (!str && (length != 0))
   {
     /* If the input string is an empty string, but length > 0
      * consider the conversion a success */
     const size_t wlen = _wcsnlen(param, length);
     if (wlen != 0)
       return FALSE;
   }
  
   return freerdp_settings_set_string_(settings, id, str, len);
 }

◆ freerdp_settings_set_string_len()

FREERDP_API BOOL freerdp_settings_set_string_len	(	rdpSettings *	settings,
		FreeRDP_Settings_Keys_String	id,
		const char *	param,
		size_t	len
	)

Sets a string settings value. The param is copied.

Parameters

settings	A pointer to the settings to query, must not be NULL.
id	The key to query
param	The value to set. If NULL allocates an empty string buffer of len size, otherwise a copy is created.
len	The length of param, 0 to remove the old entry.

Returns: TRUE for success, FALSE for failure

Definition at line 3610 of file settings_getters.c.

 {
   return freerdp_settings_set_string_copy_(settings, id, val, len, TRUE);
 }

Referenced by freerdp_settings_append_string().

Here is the caller graph for this function:

◆ freerdp_settings_set_uint16()

FREERDP_API BOOL freerdp_settings_set_uint16	(	rdpSettings *	settings,
		FreeRDP_Settings_Keys_UInt16	id,
		UINT16	param
	)

Sets a UINT16 settings value.

Parameters

settings	A pointer to the settings to query, must not be NULL.
id	The key to query
param	The value to set.

Returns: TRUE for success, FALSE for failure

Definition at line 1498 of file settings_getters.c.

 {
   union
   {
     void* v;
     const void* cv;
     UINT16 c;
     const UINT16 cc;
   } cnv;
   WINPR_ASSERT(settings);
  
   cnv.c = val;
  
   switch (id)
   {
     case FreeRDP_CapsGeneralCompressionLevel:
       settings->CapsGeneralCompressionLevel = cnv.c;
       break;
  
     case FreeRDP_CapsGeneralCompressionTypes:
       settings->CapsGeneralCompressionTypes = cnv.c;
       break;
  
     case FreeRDP_CapsProtocolVersion:
       settings->CapsProtocolVersion = cnv.c;
       break;
  
     case FreeRDP_CapsRemoteUnshareFlag:
       settings->CapsRemoteUnshareFlag = cnv.c;
       break;
  
     case FreeRDP_CapsUpdateCapabilityFlag:
       settings->CapsUpdateCapabilityFlag = cnv.c;
       break;
  
     case FreeRDP_DesktopOrientation:
       settings->DesktopOrientation = cnv.c;
       break;
  
     case FreeRDP_OrderSupportFlags:
       settings->OrderSupportFlags = cnv.c;
       break;
  
     case FreeRDP_OrderSupportFlagsEx:
       settings->OrderSupportFlagsEx = cnv.c;
       break;
  
     case FreeRDP_ProxyPort:
       settings->ProxyPort = cnv.c;
       break;
  
     case FreeRDP_SupportedColorDepths:
       settings->SupportedColorDepths = cnv.c;
       break;
  
     case FreeRDP_TLSMaxVersion:
       settings->TLSMaxVersion = cnv.c;
       break;
  
     case FreeRDP_TLSMinVersion:
       settings->TLSMinVersion = cnv.c;
       break;
  
     case FreeRDP_TextANSICodePage:
       settings->TextANSICodePage = cnv.c;
       break;
  
     default:
       WLog_ERR(TAG, "Invalid key index %" PRIuz " [%s|%s]", id,
                freerdp_settings_get_name_for_key(id),
                freerdp_settings_get_type_name_for_key(id));
       return FALSE;
   }
   return TRUE;
 }

References freerdp_settings_get_name_for_key(), and freerdp_settings_get_type_name_for_key().

Referenced by freerdp_settings_copy_item().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ freerdp_settings_set_uint32()

FREERDP_API BOOL freerdp_settings_set_uint32	(	rdpSettings *	settings,
		FreeRDP_Settings_Keys_UInt32	id,
		UINT32	param
	)

Sets a UINT32 settings value.

Parameters

settings	A pointer to the settings to query, must not be NULL.
id	The key to query
param	The value to set.

Returns: TRUE for success, FALSE for failure

Definition at line 2006 of file settings_getters.c.

 {
   union
   {
     void* v;
     const void* cv;
     UINT32 c;
     const UINT32 cc;
   } cnv;
   WINPR_ASSERT(settings);
  
   cnv.c = val;
  
   switch (id)
   {
     case FreeRDP_AcceptedCertLength:
       settings->AcceptedCertLength = cnv.c;
       break;
  
     case FreeRDP_AuthenticationLevel:
       settings->AuthenticationLevel = cnv.c;
       break;
  
     case FreeRDP_AutoReconnectMaxRetries:
       settings->AutoReconnectMaxRetries = cnv.c;
       break;
  
     case FreeRDP_BitmapCacheV2NumCells:
       settings->BitmapCacheV2NumCells = cnv.c;
       break;
  
     case FreeRDP_BitmapCacheV3CodecId:
       settings->BitmapCacheV3CodecId = cnv.c;
       break;
  
     case FreeRDP_BitmapCacheVersion:
       settings->BitmapCacheVersion = cnv.c;
       break;
  
     case FreeRDP_BrushSupportLevel:
       settings->BrushSupportLevel = cnv.c;
       break;
  
     case FreeRDP_ChannelCount:
       settings->ChannelCount = cnv.c;
       break;
  
     case FreeRDP_ChannelDefArraySize:
       settings->ChannelDefArraySize = cnv.c;
       break;
  
     case FreeRDP_ClientBuild:
       settings->ClientBuild = cnv.c;
       break;
  
     case FreeRDP_ClientRandomLength:
       settings->ClientRandomLength = cnv.c;
       break;
  
     case FreeRDP_ClientSessionId:
       settings->ClientSessionId = cnv.c;
       break;
  
     case FreeRDP_ClipboardFeatureMask:
       settings->ClipboardFeatureMask = cnv.c;
       break;
  
     case FreeRDP_ClusterInfoFlags:
       settings->ClusterInfoFlags = cnv.c;
       break;
  
     case FreeRDP_ColorDepth:
       settings->ColorDepth = cnv.c;
       break;
  
     case FreeRDP_ColorPointerCacheSize:
       settings->ColorPointerCacheSize = cnv.c;
       break;
  
     case FreeRDP_CompDeskSupportLevel:
       settings->CompDeskSupportLevel = cnv.c;
       break;
  
     case FreeRDP_CompressionLevel:
       settings->CompressionLevel = cnv.c;
       break;
  
     case FreeRDP_ConnectionType:
       settings->ConnectionType = cnv.c;
       break;
  
     case FreeRDP_CookieMaxLength:
       settings->CookieMaxLength = cnv.c;
       break;
  
     case FreeRDP_DesktopHeight:
       settings->DesktopHeight = cnv.c;
       break;
  
     case FreeRDP_DesktopPhysicalHeight:
       settings->DesktopPhysicalHeight = cnv.c;
       break;
  
     case FreeRDP_DesktopPhysicalWidth:
       settings->DesktopPhysicalWidth = cnv.c;
       break;
  
     case FreeRDP_DesktopPosX:
       settings->DesktopPosX = cnv.c;
       break;
  
     case FreeRDP_DesktopPosY:
       settings->DesktopPosY = cnv.c;
       break;
  
     case FreeRDP_DesktopScaleFactor:
       settings->DesktopScaleFactor = cnv.c;
       break;
  
     case FreeRDP_DesktopWidth:
       settings->DesktopWidth = cnv.c;
       break;
  
     case FreeRDP_DeviceArraySize:
       settings->DeviceArraySize = cnv.c;
       break;
  
     case FreeRDP_DeviceCount:
       settings->DeviceCount = cnv.c;
       break;
  
     case FreeRDP_DeviceScaleFactor:
       settings->DeviceScaleFactor = cnv.c;
       break;
  
     case FreeRDP_DrawNineGridCacheEntries:
       settings->DrawNineGridCacheEntries = cnv.c;
       break;
  
     case FreeRDP_DrawNineGridCacheSize:
       settings->DrawNineGridCacheSize = cnv.c;
       break;
  
     case FreeRDP_DynamicChannelArraySize:
       settings->DynamicChannelArraySize = cnv.c;
       break;
  
     case FreeRDP_DynamicChannelCount:
       settings->DynamicChannelCount = cnv.c;
       break;
  
     case FreeRDP_EarlyCapabilityFlags:
       settings->EarlyCapabilityFlags = cnv.c;
       break;
  
     case FreeRDP_EncryptionLevel:
       settings->EncryptionLevel = cnv.c;
       break;
  
     case FreeRDP_EncryptionMethods:
       settings->EncryptionMethods = cnv.c;
       break;
  
     case FreeRDP_ExtEncryptionMethods:
       settings->ExtEncryptionMethods = cnv.c;
       break;
  
     case FreeRDP_FakeMouseMotionInterval:
       settings->FakeMouseMotionInterval = cnv.c;
       break;
  
     case FreeRDP_Floatbar:
       settings->Floatbar = cnv.c;
       break;
  
     case FreeRDP_ForceIPvX:
       settings->ForceIPvX = cnv.c;
       break;
  
     case FreeRDP_FrameAcknowledge:
       settings->FrameAcknowledge = cnv.c;
       break;
  
     case FreeRDP_GatewayAcceptedCertLength:
       settings->GatewayAcceptedCertLength = cnv.c;
       break;
  
     case FreeRDP_GatewayCredentialsSource:
       settings->GatewayCredentialsSource = cnv.c;
       break;
  
     case FreeRDP_GatewayPort:
       settings->GatewayPort = cnv.c;
       break;
  
     case FreeRDP_GatewayUsageMethod:
       settings->GatewayUsageMethod = cnv.c;
       break;
  
     case FreeRDP_GfxCapsFilter:
       settings->GfxCapsFilter = cnv.c;
       break;
  
     case FreeRDP_GlyphSupportLevel:
       settings->GlyphSupportLevel = cnv.c;
       break;
  
     case FreeRDP_JpegCodecId:
       settings->JpegCodecId = cnv.c;
       break;
  
     case FreeRDP_JpegQuality:
       settings->JpegQuality = cnv.c;
       break;
  
     case FreeRDP_KeySpec:
       settings->KeySpec = cnv.c;
       break;
  
     case FreeRDP_KeyboardCodePage:
       settings->KeyboardCodePage = cnv.c;
       break;
  
     case FreeRDP_KeyboardFunctionKey:
       settings->KeyboardFunctionKey = cnv.c;
       break;
  
     case FreeRDP_KeyboardHook:
       settings->KeyboardHook = cnv.c;
       break;
  
     case FreeRDP_KeyboardLayout:
       settings->KeyboardLayout = cnv.c;
       break;
  
     case FreeRDP_KeyboardSubType:
       settings->KeyboardSubType = cnv.c;
       break;
  
     case FreeRDP_KeyboardType:
       settings->KeyboardType = cnv.c;
       break;
  
     case FreeRDP_LargePointerFlag:
       settings->LargePointerFlag = cnv.c;
       break;
  
     case FreeRDP_LoadBalanceInfoLength:
       settings->LoadBalanceInfoLength = cnv.c;
       break;
  
     case FreeRDP_MonitorAttributeFlags:
       settings->MonitorAttributeFlags = cnv.c;
       break;
  
     case FreeRDP_MonitorCount:
       settings->MonitorCount = cnv.c;
       break;
  
     case FreeRDP_MonitorDefArraySize:
       settings->MonitorDefArraySize = cnv.c;
       break;
  
     case FreeRDP_MonitorFlags:
       settings->MonitorFlags = cnv.c;
       break;
  
     case FreeRDP_MonitorLocalShiftX:
       settings->MonitorLocalShiftX = cnv.c;
       break;
  
     case FreeRDP_MonitorLocalShiftY:
       settings->MonitorLocalShiftY = cnv.c;
       break;
  
     case FreeRDP_MultifragMaxRequestSize:
       settings->MultifragMaxRequestSize = cnv.c;
       break;
  
     case FreeRDP_MultitransportFlags:
       settings->MultitransportFlags = cnv.c;
       break;
  
     case FreeRDP_NSCodecColorLossLevel:
       settings->NSCodecColorLossLevel = cnv.c;
       break;
  
     case FreeRDP_NSCodecId:
       settings->NSCodecId = cnv.c;
       break;
  
     case FreeRDP_NegotiationFlags:
       settings->NegotiationFlags = cnv.c;
       break;
  
     case FreeRDP_NumMonitorIds:
       settings->NumMonitorIds = cnv.c;
       break;
  
     case FreeRDP_OffscreenCacheEntries:
       settings->OffscreenCacheEntries = cnv.c;
       break;
  
     case FreeRDP_OffscreenCacheSize:
       settings->OffscreenCacheSize = cnv.c;
       break;
  
     case FreeRDP_OffscreenSupportLevel:
       settings->OffscreenSupportLevel = cnv.c;
       break;
  
     case FreeRDP_OsMajorType:
       settings->OsMajorType = cnv.c;
       break;
  
     case FreeRDP_OsMinorType:
       settings->OsMinorType = cnv.c;
       break;
  
     case FreeRDP_Password51Length:
       settings->Password51Length = cnv.c;
       break;
  
     case FreeRDP_PduSource:
       settings->PduSource = cnv.c;
       break;
  
     case FreeRDP_PercentScreen:
       settings->PercentScreen = cnv.c;
       break;
  
     case FreeRDP_PerformanceFlags:
       settings->PerformanceFlags = cnv.c;
       break;
  
     case FreeRDP_PointerCacheSize:
       settings->PointerCacheSize = cnv.c;
       break;
  
     case FreeRDP_PreconnectionId:
       settings->PreconnectionId = cnv.c;
       break;
  
     case FreeRDP_ProxyType:
       settings->ProxyType = cnv.c;
       break;
  
     case FreeRDP_RdpVersion:
       settings->RdpVersion = cnv.c;
       break;
  
     case FreeRDP_ReceivedCapabilitiesSize:
       settings->ReceivedCapabilitiesSize = cnv.c;
       break;
  
     case FreeRDP_RedirectedSessionId:
       settings->RedirectedSessionId = cnv.c;
       break;
  
     case FreeRDP_RedirectionAcceptedCertLength:
       settings->RedirectionAcceptedCertLength = cnv.c;
       break;
  
     case FreeRDP_RedirectionFlags:
       settings->RedirectionFlags = cnv.c;
       break;
  
     case FreeRDP_RedirectionGuidLength:
       settings->RedirectionGuidLength = cnv.c;
       break;
  
     case FreeRDP_RedirectionPasswordLength:
       settings->RedirectionPasswordLength = cnv.c;
       break;
  
     case FreeRDP_RedirectionPreferType:
       settings->RedirectionPreferType = cnv.c;
       break;
  
     case FreeRDP_RedirectionTsvUrlLength:
       settings->RedirectionTsvUrlLength = cnv.c;
       break;
  
     case FreeRDP_RemoteAppNumIconCacheEntries:
       settings->RemoteAppNumIconCacheEntries = cnv.c;
       break;
  
     case FreeRDP_RemoteAppNumIconCaches:
       settings->RemoteAppNumIconCaches = cnv.c;
       break;
  
     case FreeRDP_RemoteApplicationExpandCmdLine:
       settings->RemoteApplicationExpandCmdLine = cnv.c;
       break;
  
     case FreeRDP_RemoteApplicationExpandWorkingDir:
       settings->RemoteApplicationExpandWorkingDir = cnv.c;
       break;
  
     case FreeRDP_RemoteApplicationSupportLevel:
       settings->RemoteApplicationSupportLevel = cnv.c;
       break;
  
     case FreeRDP_RemoteApplicationSupportMask:
       settings->RemoteApplicationSupportMask = cnv.c;
       break;
  
     case FreeRDP_RemoteFxCaptureFlags:
       settings->RemoteFxCaptureFlags = cnv.c;
       break;
  
     case FreeRDP_RemoteFxCodecId:
       settings->RemoteFxCodecId = cnv.c;
       break;
  
     case FreeRDP_RemoteFxCodecMode:
       settings->RemoteFxCodecMode = cnv.c;
       break;
  
     case FreeRDP_RemoteFxRlgrMode:
       settings->RemoteFxRlgrMode = cnv.c;
       break;
  
     case FreeRDP_RemoteWndSupportLevel:
       settings->RemoteWndSupportLevel = cnv.c;
       break;
  
     case FreeRDP_RequestedProtocols:
       settings->RequestedProtocols = cnv.c;
       break;
  
     case FreeRDP_SelectedProtocol:
       settings->SelectedProtocol = cnv.c;
       break;
  
     case FreeRDP_ServerCertificateLength:
       settings->ServerCertificateLength = cnv.c;
       break;
  
     case FreeRDP_ServerLicenseProductIssuersCount:
       settings->ServerLicenseProductIssuersCount = cnv.c;
       break;
  
     case FreeRDP_ServerLicenseProductVersion:
       settings->ServerLicenseProductVersion = cnv.c;
       break;
  
     case FreeRDP_ServerPort:
       settings->ServerPort = cnv.c;
       break;
  
     case FreeRDP_ServerRandomLength:
       settings->ServerRandomLength = cnv.c;
       break;
  
     case FreeRDP_ShareId:
       settings->ShareId = cnv.c;
       break;
  
     case FreeRDP_SmartSizingHeight:
       settings->SmartSizingHeight = cnv.c;
       break;
  
     case FreeRDP_SmartSizingWidth:
       settings->SmartSizingWidth = cnv.c;
       break;
  
     case FreeRDP_StaticChannelArraySize:
       settings->StaticChannelArraySize = cnv.c;
       break;
  
     case FreeRDP_StaticChannelCount:
       settings->StaticChannelCount = cnv.c;
       break;
  
     case FreeRDP_SurfaceCommandsSupported:
       settings->SurfaceCommandsSupported = cnv.c;
       break;
  
     case FreeRDP_TargetNetAddressCount:
       settings->TargetNetAddressCount = cnv.c;
       break;
  
     case FreeRDP_TcpAckTimeout:
       settings->TcpAckTimeout = cnv.c;
       break;
  
     case FreeRDP_TcpConnectTimeout:
       settings->TcpConnectTimeout = cnv.c;
       break;
  
     case FreeRDP_TcpKeepAliveDelay:
       settings->TcpKeepAliveDelay = cnv.c;
       break;
  
     case FreeRDP_TcpKeepAliveInterval:
       settings->TcpKeepAliveInterval = cnv.c;
       break;
  
     case FreeRDP_TcpKeepAliveRetries:
       settings->TcpKeepAliveRetries = cnv.c;
       break;
  
     case FreeRDP_ThreadingFlags:
       settings->ThreadingFlags = cnv.c;
       break;
  
     case FreeRDP_TlsSecLevel:
       settings->TlsSecLevel = cnv.c;
       break;
  
     case FreeRDP_VCChunkSize:
       settings->VCChunkSize = cnv.c;
       break;
  
     case FreeRDP_VCFlags:
       settings->VCFlags = cnv.c;
       break;
  
     default:
       WLog_ERR(TAG, "Invalid key index %" PRIuz " [%s|%s]", id,
                freerdp_settings_get_name_for_key(id),
                freerdp_settings_get_type_name_for_key(id));
       return FALSE;
   }
   return TRUE;
 }

References freerdp_settings_get_name_for_key(), and freerdp_settings_get_type_name_for_key().

Referenced by freerdp_set_gateway_usage_method(), and freerdp_settings_copy_item().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ freerdp_settings_set_uint64()

FREERDP_API BOOL freerdp_settings_set_uint64	(	rdpSettings *	settings,
		FreeRDP_Settings_Keys_UInt64	id,
		UINT64	param
	)

Sets a UINT64 settings value.

Parameters

settings	A pointer to the settings to query, must not be NULL.
id	The key to query
param	The value to set.

Returns: TRUE for success, FALSE for failure

Definition at line 2605 of file settings_getters.c.

 {
   union
   {
     void* v;
     const void* cv;
     UINT64 c;
     const UINT64 cc;
   } cnv;
   WINPR_ASSERT(settings);
  
   cnv.c = val;
  
   switch (id)
   {
     case FreeRDP_ParentWindowId:
       settings->ParentWindowId = cnv.c;
       break;
  
     default:
       WLog_ERR(TAG, "Invalid key index %" PRIuz " [%s|%s]", id,
                freerdp_settings_get_name_for_key(id),
                freerdp_settings_get_type_name_for_key(id));
       return FALSE;
   }
   return TRUE;
 }

References freerdp_settings_get_name_for_key(), and freerdp_settings_get_type_name_for_key().

Referenced by freerdp_settings_copy_item().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ freerdp_settings_update_from_caps()

FREERDP_API BOOL freerdp_settings_update_from_caps	(	rdpSettings *	settings,
		const BYTE *	capsFlags,
		const BYTE **	capsData,
		const UINT32 *	capsSizes,
		UINT32	capsCount,
		BOOL	serverReceivedCaps
	)

Parse capability data and apply to settings.

The capability message is stored in raw form in the settings, the data parsed and applied to the settings.

Parameters

settings	A pointer to the settings to use
capsFlags	A pointer to the capablity flags, must have capsCount fields
capsData	A pointer array to the RAW capability data, must have capsCount fields
capsSizes	A pointer to an array of RAW capability sizes, must have capsCount fields
capsCount	The number of capabilities contained in the RAW data
serverReceivedCaps	Indicates if the parser should assume to be a server or client instance

Returns: TRUE for success, FALSE in case of an error

Definition at line 1990 of file common/settings.c.

 {
   WINPR_ASSERT(settings);
   WINPR_ASSERT(capsFlags || (capsCount == 0));
   WINPR_ASSERT(capsData || (capsCount == 0));
   WINPR_ASSERT(capsSizes || (capsCount == 0));
   WINPR_ASSERT(capsCount <= UINT16_MAX);
  
   for (UINT32 x = 0; x < capsCount; x++)
   {
     if (capsFlags[x])
     {
       wStream buffer;
       wStream* sub = Stream_StaticConstInit(&buffer, capsData[x], capsSizes[x]);
  
       if (!rdp_read_capability_set(sub, (UINT16)x, settings, serverReceivedCaps))
         return FALSE;
     }
   }
  
   return TRUE;
 }

◆ freerdp_supported_color_depths_string()

FREERDP_API const char* freerdp_supported_color_depths_string	(	UINT16	mask,
		char *	buffer,
		size_t	size
	)

returns a string representation of RNS_UD_XXBPP_SUPPORT values

return A string reprenentation of the bitmask.

Definition at line 2171 of file common/settings.c.

 {
   const UINT32 invalid = mask & ~(RNS_UD_32BPP_SUPPORT | RNS_UD_24BPP_SUPPORT |
                                   RNS_UD_16BPP_SUPPORT | RNS_UD_15BPP_SUPPORT);
  
   if (mask & RNS_UD_32BPP_SUPPORT)
     winpr_str_append("RNS_UD_32BPP_SUPPORT", buffer, size, "|");
   if (mask & RNS_UD_24BPP_SUPPORT)
     winpr_str_append("RNS_UD_24BPP_SUPPORT", buffer, size, "|");
   if (mask & RNS_UD_16BPP_SUPPORT)
     winpr_str_append("RNS_UD_16BPP_SUPPORT", buffer, size, "|");
   if (mask & RNS_UD_15BPP_SUPPORT)
     winpr_str_append("RNS_UD_15BPP_SUPPORT", buffer, size, "|");
  
   if (invalid != 0)
   {
     char str[32] = { 0 };
     (void)_snprintf(str, sizeof(str), "RNS_UD_INVALID[0x%04" PRIx32 "]", invalid);
     winpr_str_append(str, buffer, size, "|");
   }
   char hex[32] = { 0 };
   (void)_snprintf(hex, sizeof(hex), "[0x%04" PRIx16 "]", mask);
   return buffer;
 }

Data Structures

Macros

Enumerations

Functions

Detailed Description

Data Structure Documentation

◆ TARGET_NET_ADDRESS

◆ ARC_CS_PRIVATE_PACKET

◆ ARC_SC_PRIVATE_PACKET

◆ ADDIN_ARGV

◆ rdp_ext_set

◆ BITMAP_CACHE_CELL_INFO

◆ BITMAP_CACHE_V2_CELL_INFO

◆ GLYPH_CACHE_DEFINITION

◆ MONITOR_DEF

◆ MONITOR_ATTRIBUTES

◆ rdpMonitor

◆ RDPDR_DEVICE

◆ RDPDR_DRIVE

◆ RDPDR_PRINTER

◆ RDPDR_SMARTCARD

◆ RDPDR_SERIAL

◆ RDPDR_PARALLEL

Macro Definition Documentation

◆ CLIPRDR_FLAG_DEFAULT_MASK

◆ CONNECTION_TYPE_INVALID

◆ FREERDP_SETTINGS_SERVER_MODE [1/2]

◆ FREERDP_SETTINGS_SERVER_MODE [2/2]

Function Documentation

◆ freerdp_device_collection_del()

◆ freerdp_rail_support_flags_to_string()

◆ freerdp_rdp_version_string()

◆ freerdp_rdpdr_dtyp_string()

◆ freerdp_set_gateway_usage_method()

◆ freerdp_settings_append_string()

◆ freerdp_settings_are_valid()

◆ freerdp_settings_clone()

◆ freerdp_settings_copy()

◆ freerdp_settings_copy_item()

◆ freerdp_settings_dump()

◆ freerdp_settings_free()

◆ freerdp_settings_get_bool()

◆ freerdp_settings_get_codecs_flags()

◆ freerdp_settings_get_config_path()

◆ freerdp_settings_get_int16()

◆ freerdp_settings_get_int32()

◆ freerdp_settings_get_int64()

◆ freerdp_settings_get_key_for_name()

◆ freerdp_settings_get_name_for_key()

◆ freerdp_settings_get_pointer()

◆ freerdp_settings_get_pointer_writable()

◆ freerdp_settings_get_server_name()

◆ freerdp_settings_get_string()

◆ freerdp_settings_get_string_as_utf16()

◆ freerdp_settings_get_string_writable()

◆ freerdp_settings_get_type_for_key()

◆ freerdp_settings_get_type_for_name()

◆ freerdp_settings_get_type_name_for_key()

◆ freerdp_settings_get_type_name_for_type()

◆ freerdp_settings_get_uint16()

◆ freerdp_settings_get_uint32()

◆ freerdp_settings_get_uint64()

◆ freerdp_settings_new()

◆ freerdp_settings_print_diff()

◆ freerdp_settings_set_bool()

◆ freerdp_settings_set_int16()

◆ freerdp_settings_set_int32()

◆ freerdp_settings_set_int64()

◆ freerdp_settings_set_pointer()

◆ freerdp_settings_set_pointer_len()

◆ freerdp_settings_set_string()

◆ freerdp_settings_set_string_from_utf16()

◆ freerdp_settings_set_string_from_utf16N()

◆ freerdp_settings_set_string_len()

◆ freerdp_settings_set_uint16()

◆ freerdp_settings_set_uint32()

◆ freerdp_settings_set_uint64()

◆ freerdp_settings_update_from_caps()

◆ freerdp_supported_color_depths_string()