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	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	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	FREERDP_MONITOR_OVERRIDE_ORIENTATION (1 << 0) /** @since version 3.15.0 */

#define	FREERDP_MONITOR_OVERRIDE_DESKTOP_SCALE (1 << 1) /** @since version 3.15.0 */

#define	FREERDP_MONITOR_OVERRIDE_DEVICE_SCALE (1 << 2) /** @since version 3.15.0 */

#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	FreeRDP_OrderSupportFlagConstants { NEG_DSTBLT_INDEX = 0x00 , NEG_PATBLT_INDEX = 0x01 , NEG_SCRBLT_INDEX = 0x02 , NEG_MEMBLT_INDEX = 0x03 , NEG_MEM3BLT_INDEX = 0x04 , NEG_ATEXTOUT_INDEX = 0x05 , NEG_AEXTTEXTOUT_INDEX = 0x06 , NEG_DRAWNINEGRID_INDEX = 0x07 , NEG_LINETO_INDEX = 0x08 , NEG_MULTI_DRAWNINEGRID_INDEX = 0x09 , NEG_OPAQUE_RECT_INDEX = 0x0A , NEG_SAVEBITMAP_INDEX = 0x0B , NEG_WTEXTOUT_INDEX = 0x0C , NEG_MEMBLT_V2_INDEX = 0x0D , NEG_MEM3BLT_V2_INDEX = 0x0E , NEG_MULTIDSTBLT_INDEX = 0x0F , NEG_MULTIPATBLT_INDEX = 0x10 , NEG_MULTISCRBLT_INDEX = 0x11 , NEG_MULTIOPAQUERECT_INDEX = 0x12 , NEG_FAST_INDEX_INDEX = 0x13 , NEG_POLYGON_SC_INDEX = 0x14 , NEG_POLYGON_CB_INDEX = 0x15 , NEG_POLYLINE_INDEX = 0x16 , NEG_UNUSED23_INDEX = 0x17 , NEG_FAST_GLYPH_INDEX = 0x18 , NEG_ELLIPSE_SC_INDEX = 0x19 , NEG_ELLIPSE_CB_INDEX = 0x1A , NEG_GLYPH_INDEX_INDEX = 0x1B , NEG_GLYPH_WEXTTEXTOUT_INDEX = 0x1C , NEG_GLYPH_WLONGTEXTOUT_INDEX = 0x1D , NEG_GLYPH_WLONGEXTTEXTOUT_INDEX = 0x1E , NEG_UNUSED31_INDEX = 0x1F }

enum	FreeRDP_DesktopRotationFlags { ORIENTATION_LANDSCAPE = 0 , ORIENTATION_PORTRAIT = 90 , ORIENTATION_LANDSCAPE_FLIPPED = 180 , ORIENTATION_PORTRAIT_FLIPPED = 270 }

enum	FreeRDP_RDPDR_DTYP { RDPDR_DTYP_SERIAL = 0x00000001 , RDPDR_DTYP_PARALLEL = 0x00000002 , RDPDR_DTYP_PRINT = 0x00000004 , RDPDR_DTYP_FILESYSTEM = 0x00000008 , RDPDR_DTYP_SMARTCARD = 0x00000020 }

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.

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

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

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

WINPR_ATTR_NODISCARD 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

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

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.

FREERDP_API void	freerdp_addin_argv_free (ADDIN_ARGV *args)

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

WINPR_ATTR_NODISCARD 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.

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

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

FREERDP_API void	freerdp_device_free (RDPDR_DEVICE *device)

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

WINPR_ATTR_NODISCARD FREERDP_API RDPDR_DEVICE *	freerdp_device_clone (const RDPDR_DEVICE *device)

WINPR_ATTR_NODISCARD 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)

WINPR_ATTR_NODISCARD 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)

WINPR_ATTR_NODISCARD 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)

WINPR_ATTR_NODISCARD FREERDP_API BOOL	freerdp_capability_buffer_copy (rdpSettings settings, const rdpSettings src)

FREERDP_API void	freerdp_server_license_issuers_free (rdpSettings *settings)

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

FREERDP_API void	freerdp_target_net_addresses_free (rdpSettings *settings)

WINPR_ATTR_NODISCARD 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)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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.

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,

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.

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.

WINPR_ATTR_NODISCARD 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.

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

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

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

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.

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

WINPR_ATTR_NODISCARD 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)

to value \b value

Set a setting Both, key and value are provided as strings and parsed internally.

The value will be checked internally:

Integer types must be within boundaries
BOOL must be any of {'true', 'false', 'on', 'off', '0', '1'} (case insensitive)
Strings are passed on as is
Pointers are also passed as is

Parameters

settings	The settings instance to set the value, must not be NULL
name	The name of the settings key (like 'FreeRDP_Domain', same as output of freerdp_settings_get_name_for_key ) Must not be NULL
value	The value of the setting. Must not be NULL

Note: If the function fails check wLog output for details

Since: version 3.0.0

Returns: TRUE in case of success, FALSE otherwise.

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

WINPR_ATTR_NODISCARD FREERDP_API SSIZE_T freerdp_settings_get_key_for_name (const char *value)

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

WINPR_ATTR_NODISCARD FREERDP_API SSIZE_T freerdp_settings_get_type_for_name (const char *value)

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

WINPR_ATTR_NODISCARD FREERDP_API SSIZE_T freerdp_settings_get_type_for_key (SSIZE_T key)

Get a key type for the key index.

WINPR_ATTR_NODISCARD FREERDP_API const char * freerdp_settings_get_type_name_for_key (SSIZE_T key)

Returns the type name for a key.

WINPR_ATTR_NODISCARD FREERDP_API const char * freerdp_settings_get_type_name_for_type (SSIZE_T type)

Returns the type name for a type.

WINPR_ATTR_NODISCARD FREERDP_API const char * freerdp_settings_get_name_for_key (SSIZE_T key)

Returns the type name for a key.

WINPR_ATTR_NODISCARD FREERDP_API UINT32 freerdp_settings_get_codecs_flags (const rdpSettings *settings)

helper function to get a mask of supported codec flags.

WINPR_ATTR_NODISCARD 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.

WINPR_ATTR_NODISCARD FREERDP_API const char * freerdp_settings_get_server_name (const rdpSettings *settings)

A helper function to return the correct server name.

WINPR_ATTR_NODISCARD 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.

WINPR_ATTR_NODISCARD FREERDP_API const char * freerdp_rdp_version_string (UINT32 version)

Returns a stringified representation of the RDP protocol version.

WINPR_ATTR_NODISCARD FREERDP_API const char * freerdp_rdpdr_dtyp_string (UINT32 type)

Returns a string representation of RDPDR_DTYP_*.

WINPR_ATTR_NODISCARD FREERDP_API const char * freerdp_encryption_level_string (UINT32 EncryptionLevel)

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

WINPR_ATTR_NODISCARD 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

WINPR_ATTR_NODISCARD FREERDP_API char * freerdp_settings_get_config_path (void)

return the configuration directory for the library

WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_monitor_def_array_sorted (rdpSettings *settings, const rdpMonitor *monitors, size_t count)

Sort monitor array according to:

WINPR_ATTR_NODISCARD FREERDP_API char * freerdp_settings_serialize (const rdpSettings *settings, BOOL pretty, size_t *plength)

A function that converts a rdpSettings struct to a JSON serialized string.

WINPR_ATTR_NODISCARD FREERDP_API rdpSettings * freerdp_settings_deserialize (const char *json, size_t length)

A function that converts a JSON string to a rdpSettings struct.

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 293 of file settings_types.h.

Data Fields
LPWSTR	Address
UINT32	Length

◆ ARC_CS_PRIVATE_PACKET

struct ARC_CS_PRIVATE_PACKET

Definition at line 353 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 362 of file settings_types.h.

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

◆ ADDIN_ARGV

struct ADDIN_ARGV

Definition at line 372 of file settings_types.h.

Data Fields
int	argc
char **	argv

◆ rdp_ext_set

struct rdp_ext_set

Definition at line 380 of file settings_types.h.

Data Fields
void *	data
char	name[256]

◆ BITMAP_CACHE_CELL_INFO

struct BITMAP_CACHE_CELL_INFO

Definition at line 388 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 394 of file settings_types.h.

Data Fields
UINT32	numEntries
BOOL	persistent

◆ GLYPH_CACHE_DEFINITION

struct GLYPH_CACHE_DEFINITION

Definition at line 402 of file settings_types.h.

Data Fields
UINT16	cacheEntries
UINT16	cacheMaximumCellSize

◆ MONITOR_DEF

struct MONITOR_DEF

Definition at line 410 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 419 of file settings_types.h.

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

◆ rdpMonitor

struct rdpMonitor

Definition at line 428 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 449 of file settings_types.h.

Data Fields
UINT32	Id
char *	Name
UINT32	Type

◆ RDPDR_DRIVE

struct RDPDR_DRIVE

Definition at line 456 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 463 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 470 of file settings_types.h.

Collaboration diagram for RDPDR_SMARTCARD:

[legend]

Data Fields
RDPDR_DEVICE	device

◆ RDPDR_SERIAL

struct RDPDR_SERIAL

Definition at line 475 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 483 of file settings_types.h.

Collaboration diagram for RDPDR_PARALLEL:

[legend]

Data Fields
RDPDR_DEVICE	device
char *	Path

Macro Definition Documentation

◆ AUDIO_MODE_NONE

#define AUDIO_MODE_NONE 2 /* Do not play */

Definition at line 144 of file settings_types.h.

◆ AUDIO_MODE_PLAY_ON_SERVER

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

Definition at line 143 of file settings_types.h.

◆ AUDIO_MODE_REDIRECT

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

Definition at line 142 of file settings_types.h.

◆ AUTO_RECONNECT_VERSION_1

#define AUTO_RECONNECT_VERSION_1 0x00000001

Definition at line 224 of file settings_types.h.

◆ CHANNEL_OPTION_COMPRESS

#define CHANNEL_OPTION_COMPRESS 0x00400000

Definition at line 210 of file settings_types.h.

◆ CHANNEL_OPTION_COMPRESS_RDP

#define CHANNEL_OPTION_COMPRESS_RDP 0x00800000

Definition at line 209 of file settings_types.h.

◆ CHANNEL_OPTION_ENCRYPT_CS

#define CHANNEL_OPTION_ENCRYPT_CS 0x10000000

Definition at line 205 of file settings_types.h.

◆ CHANNEL_OPTION_ENCRYPT_RDP

#define CHANNEL_OPTION_ENCRYPT_RDP 0x40000000

Definition at line 203 of file settings_types.h.

◆ CHANNEL_OPTION_ENCRYPT_SC

#define CHANNEL_OPTION_ENCRYPT_SC 0x20000000

Definition at line 204 of file settings_types.h.

◆ CHANNEL_OPTION_INITIALIZED

#define CHANNEL_OPTION_INITIALIZED 0x80000000

Definition at line 202 of file settings_types.h.

◆ CHANNEL_OPTION_PRI_HIGH

#define CHANNEL_OPTION_PRI_HIGH 0x08000000

Definition at line 206 of file settings_types.h.

◆ CHANNEL_OPTION_PRI_LOW

#define CHANNEL_OPTION_PRI_LOW 0x02000000

Definition at line 208 of file settings_types.h.

◆ CHANNEL_OPTION_PRI_MED

#define CHANNEL_OPTION_PRI_MED 0x04000000

Definition at line 207 of file settings_types.h.

◆ CHANNEL_OPTION_SHOW_PROTOCOL

#define CHANNEL_OPTION_SHOW_PROTOCOL 0x00200000

Definition at line 211 of file settings_types.h.

◆ CHANNEL_REMOTE_CONTROL_PERSISTENT

#define CHANNEL_REMOTE_CONTROL_PERSISTENT 0x00100000

Definition at line 212 of file settings_types.h.

◆ 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 343 of file settings_types.h.

  {
    UINT32 cbLen;
    UINT32 version;
    UINT32 logonId;
    BYTE securityVerifier[16];
  } ARC_CS_PRIVATE_PACKET;
 
  /* ARC_SC_PRIVATE_PACKET */
  typedef struct
  {
    UINT32 cbLen;
    UINT32 version;
    UINT32 logonId;
    BYTE arcRandomBits[16];
  } ARC_SC_PRIVATE_PACKET;
 
  /* Channels */
 
  typedef struct
  {
    int argc;
    char** argv;
  } ADDIN_ARGV;
 
  /* Extensions */
 
  struct rdp_ext_set
  {
    char name[256]; /* plugin name or path */
    void* data;     /* plugin data */
  };
 
  /* Bitmap Cache */
 
  typedef struct
  {
    UINT16 numEntries;
    UINT16 maxSize;
  } BITMAP_CACHE_CELL_INFO;
 
  typedef struct
  {
    UINT32 numEntries;
    BOOL persistent;
  } BITMAP_CACHE_V2_CELL_INFO;
 
  /* Glyph Cache */
 
  typedef struct
  {
    UINT16 cacheEntries;
    UINT16 cacheMaximumCellSize;
  } GLYPH_CACHE_DEFINITION;
 
  /* Monitors */
 
  typedef struct
  {
    INT32 left;
    INT32 top;
    INT32 right;
    INT32 bottom;
    UINT32 flags;
  } MONITOR_DEF;
 
  typedef struct
  {
    UINT32 physicalWidth;
    UINT32 physicalHeight;
    UINT32 orientation;
    UINT32 desktopScaleFactor;
    UINT32 deviceScaleFactor;
  } MONITOR_ATTRIBUTES;
 
  typedef struct
  {
    INT32 x;
    INT32 y;
    INT32 width;
    INT32 height;
    UINT32 is_primary;
    UINT32 orig_screen;
    MONITOR_ATTRIBUTES attributes;
  } rdpMonitor;
 
  /* Device Redirection */
  typedef enum
  {
    RDPDR_DTYP_SERIAL = 0x00000001,
    RDPDR_DTYP_PARALLEL = 0x00000002,
    RDPDR_DTYP_PRINT = 0x00000004,
    RDPDR_DTYP_FILESYSTEM = 0x00000008,
    RDPDR_DTYP_SMARTCARD = 0x00000020
  } FreeRDP_RDPDR_DTYP;
 
  typedef struct
  {
    UINT32 Id;
    UINT32 Type;
    char* Name;
  } RDPDR_DEVICE;
 
  typedef struct
  {
    RDPDR_DEVICE device;
    char* Path;
    BOOL automount;
  } RDPDR_DRIVE;
 
  typedef struct
  {
    RDPDR_DEVICE device;
    char* DriverName;
    BOOL IsDefault;
  } RDPDR_PRINTER;
 
  typedef struct
  {
    RDPDR_DEVICE device;
  } RDPDR_SMARTCARD;
 
  typedef struct
  {
    RDPDR_DEVICE device;
    char* Path;
    char* Driver;
    char* Permissive;
  } RDPDR_SERIAL;
 
  typedef struct
  {
    RDPDR_DEVICE device;
    char* Path;
  } RDPDR_PARALLEL;
 
#define PROXY_TYPE_NONE 0
#define PROXY_TYPE_HTTP 1
#define PROXY_TYPE_SOCKS 2
#define PROXY_TYPE_IGNORE 0xFFFF
 
/* ThreadingFlags */
#define THREADING_FLAGS_DISABLE_THREADS 0x00000001
 
  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
  };
 
#define FREERDP_SETTINGS_SERVER_MODE 0x00000001
 
#ifdef __cplusplus
}
#endif
 
#endif /* FREERDP_SETTINGS_TYPES_H */

◆ CLIPRDR_FLAG_LOCAL_TO_REMOTE

#define CLIPRDR_FLAG_LOCAL_TO_REMOTE 0x01

Definition at line 338 of file settings_types.h.

◆ CLIPRDR_FLAG_LOCAL_TO_REMOTE_FILES

#define CLIPRDR_FLAG_LOCAL_TO_REMOTE_FILES 0x02

Definition at line 339 of file settings_types.h.

◆ CLIPRDR_FLAG_REMOTE_TO_LOCAL

#define CLIPRDR_FLAG_REMOTE_TO_LOCAL 0x10

Definition at line 340 of file settings_types.h.

◆ CLIPRDR_FLAG_REMOTE_TO_LOCAL_FILES

#define CLIPRDR_FLAG_REMOTE_TO_LOCAL_FILES 0x20

Definition at line 341 of file settings_types.h.

◆ CONNECTION_TYPE_AUTODETECT

#define CONNECTION_TYPE_AUTODETECT 0x07

Definition at line 82 of file settings_types.h.

◆ CONNECTION_TYPE_BROADBAND_HIGH

#define CONNECTION_TYPE_BROADBAND_HIGH 0x04

Definition at line 79 of file settings_types.h.

◆ CONNECTION_TYPE_BROADBAND_LOW

#define CONNECTION_TYPE_BROADBAND_LOW 0x02

Definition at line 77 of file settings_types.h.

◆ CONNECTION_TYPE_INVALID

#define CONNECTION_TYPE_INVALID

Value:

0x00

Definition at line 74 of file settings_types.h.

◆ CONNECTION_TYPE_LAN

#define CONNECTION_TYPE_LAN 0x06

Definition at line 81 of file settings_types.h.

◆ CONNECTION_TYPE_MODEM

#define CONNECTION_TYPE_MODEM 0x01

Definition at line 76 of file settings_types.h.

◆ CONNECTION_TYPE_SATELLITE

#define CONNECTION_TYPE_SATELLITE 0x03

Definition at line 78 of file settings_types.h.

◆ CONNECTION_TYPE_WAN

#define CONNECTION_TYPE_WAN 0x05

Definition at line 80 of file settings_types.h.

◆ CS_CLUSTER

#define CS_CLUSTER 0xC004

Definition at line 88 of file settings_types.h.

◆ CS_CORE

#define CS_CORE 0xC001

Definition at line 85 of file settings_types.h.

◆ CS_MCS_MSGCHANNEL

#define CS_MCS_MSGCHANNEL 0xC006

Definition at line 90 of file settings_types.h.

◆ CS_MONITOR

#define CS_MONITOR 0xC005

Definition at line 89 of file settings_types.h.

◆ CS_MONITOR_EX

#define CS_MONITOR_EX 0xC008

Definition at line 91 of file settings_types.h.

◆ CS_MULTITRANSPORT

#define CS_MULTITRANSPORT 0xC00A

Definition at line 93 of file settings_types.h.

◆ CS_NET

#define CS_NET 0xC003

Definition at line 87 of file settings_types.h.

◆ CS_SECURITY

#define CS_SECURITY 0xC002

Definition at line 86 of file settings_types.h.

◆ CS_UNUSED1

#define CS_UNUSED1 0xC00C

Definition at line 92 of file settings_types.h.

◆ DEFAULT_COOKIE_MAX_LENGTH

#define DEFAULT_COOKIE_MAX_LENGTH 0xFF

Definition at line 228 of file settings_types.h.

◆ ENCRYPTION_LEVEL_CLIENT_COMPATIBLE

#define ENCRYPTION_LEVEL_CLIENT_COMPATIBLE 0x00000002

Definition at line 191 of file settings_types.h.

◆ ENCRYPTION_LEVEL_FIPS

#define ENCRYPTION_LEVEL_FIPS 0x00000004

Definition at line 193 of file settings_types.h.

◆ ENCRYPTION_LEVEL_HIGH

#define ENCRYPTION_LEVEL_HIGH 0x00000003

Definition at line 192 of file settings_types.h.

◆ ENCRYPTION_LEVEL_LOW

#define ENCRYPTION_LEVEL_LOW 0x00000001

Definition at line 190 of file settings_types.h.

◆ ENCRYPTION_LEVEL_NONE

#define ENCRYPTION_LEVEL_NONE 0x00000000

Definition at line 189 of file settings_types.h.

◆ ENCRYPTION_METHOD_128BIT

#define ENCRYPTION_METHOD_128BIT 0x00000002

Definition at line 184 of file settings_types.h.

◆ ENCRYPTION_METHOD_40BIT

#define ENCRYPTION_METHOD_40BIT 0x00000001

Definition at line 183 of file settings_types.h.

◆ ENCRYPTION_METHOD_56BIT

#define ENCRYPTION_METHOD_56BIT 0x00000008

Definition at line 185 of file settings_types.h.

◆ ENCRYPTION_METHOD_FIPS

#define ENCRYPTION_METHOD_FIPS 0x00000010

Definition at line 186 of file settings_types.h.

◆ ENCRYPTION_METHOD_NONE

#define ENCRYPTION_METHOD_NONE 0x00000000

Definition at line 182 of file settings_types.h.

◆ FREERDP_MONITOR_OVERRIDE_DESKTOP_SCALE

#define FREERDP_MONITOR_OVERRIDE_DESKTOP_SCALE (1 << 1) /** @since version 3.15.0 */

Definition at line 349 of file settings_types.h.

◆ FREERDP_MONITOR_OVERRIDE_DEVICE_SCALE

#define FREERDP_MONITOR_OVERRIDE_DEVICE_SCALE (1 << 2) /** @since version 3.15.0 */

Definition at line 350 of file settings_types.h.

◆ FREERDP_MONITOR_OVERRIDE_ORIENTATION

#define FREERDP_MONITOR_OVERRIDE_ORIENTATION (1 << 0) /** @since version 3.15.0 */

Definition at line 348 of file settings_types.h.

◆ FREERDP_SETTINGS_REMOTE_MODE

#define FREERDP_SETTINGS_REMOTE_MODE 0x00000002

Definition at line 81 of file include/freerdp/settings.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 513 of file settings_types.h.

◆ GLYPH_SUPPORT_ENCODE

#define GLYPH_SUPPORT_ENCODE 0x0003

Definition at line 274 of file settings_types.h.

◆ GLYPH_SUPPORT_FULL

#define GLYPH_SUPPORT_FULL 0x0002

Definition at line 273 of file settings_types.h.

◆ GLYPH_SUPPORT_NONE

#define GLYPH_SUPPORT_NONE 0x0000

Definition at line 271 of file settings_types.h.

◆ GLYPH_SUPPORT_PARTIAL

#define GLYPH_SUPPORT_PARTIAL 0x0001

Definition at line 272 of file settings_types.h.

◆ KEYBOARD_HOOK_FULLSCREEN_ONLY

#define KEYBOARD_HOOK_FULLSCREEN_ONLY 2

Definition at line 291 of file settings_types.h.

◆ KEYBOARD_HOOK_LOCAL

#define KEYBOARD_HOOK_LOCAL 0

Definition at line 289 of file settings_types.h.

◆ KEYBOARD_HOOK_REMOTE

#define KEYBOARD_HOOK_REMOTE 1

Definition at line 290 of file settings_types.h.

◆ LARGE_POINTER_FLAG_384x384

#define LARGE_POINTER_FLAG_384x384 0x00000002

Definition at line 221 of file settings_types.h.

◆ LARGE_POINTER_FLAG_96x96

#define LARGE_POINTER_FLAG_96x96 0x00000001

Definition at line 220 of file settings_types.h.

◆ LOGON_FAILED_BAD_PASSWORD

#define LOGON_FAILED_BAD_PASSWORD 0x00000000

Definition at line 307 of file settings_types.h.

◆ LOGON_FAILED_OTHER

#define LOGON_FAILED_OTHER 0x00000002

Definition at line 309 of file settings_types.h.

◆ LOGON_FAILED_UPDATE_PASSWORD

#define LOGON_FAILED_UPDATE_PASSWORD 0x00000001

Definition at line 308 of file settings_types.h.

◆ LOGON_MSG_BUMP_OPTIONS

#define LOGON_MSG_BUMP_OPTIONS 0xFFFFFFFB

Definition at line 302 of file settings_types.h.

◆ LOGON_MSG_DISCONNECT_REFUSED

#define LOGON_MSG_DISCONNECT_REFUSED 0xFFFFFFF9

Definition at line 300 of file settings_types.h.

◆ LOGON_MSG_NO_PERMISSION

#define LOGON_MSG_NO_PERMISSION 0xFFFFFFFA

Definition at line 301 of file settings_types.h.

◆ LOGON_MSG_RECONNECT_OPTIONS

#define LOGON_MSG_RECONNECT_OPTIONS 0xFFFFFFFC

Definition at line 303 of file settings_types.h.

◆ LOGON_MSG_SESSION_CONTINUE

#define LOGON_MSG_SESSION_CONTINUE 0xFFFFFFFE

Definition at line 305 of file settings_types.h.

◆ LOGON_MSG_SESSION_TERMINATE

#define LOGON_MSG_SESSION_TERMINATE 0xFFFFFFFD

Definition at line 304 of file settings_types.h.

◆ LOGON_WARNING

#define LOGON_WARNING 0x00000003

Definition at line 310 of file settings_types.h.

◆ MONITOR_PRIMARY

#define MONITOR_PRIMARY 0x00000001

Definition at line 179 of file settings_types.h.

◆ MSTSC_COOKIE_MAX_LENGTH

#define MSTSC_COOKIE_MAX_LENGTH 9

Definition at line 227 of file settings_types.h.

◆ PACKET_COMPR_TYPE_64K

#define PACKET_COMPR_TYPE_64K 0x01

Definition at line 323 of file settings_types.h.

◆ PACKET_COMPR_TYPE_8K

#define PACKET_COMPR_TYPE_8K 0x00

Definition at line 322 of file settings_types.h.

◆ PACKET_COMPR_TYPE_RDP6

#define PACKET_COMPR_TYPE_RDP6 0x02

Definition at line 324 of file settings_types.h.

◆ PACKET_COMPR_TYPE_RDP61

#define PACKET_COMPR_TYPE_RDP61 0x03

Definition at line 325 of file settings_types.h.

◆ PACKET_COMPR_TYPE_RDP8

#define PACKET_COMPR_TYPE_RDP8 0x04

Definition at line 326 of file settings_types.h.

◆ PERF_DISABLE_CURSOR_SHADOW

#define PERF_DISABLE_CURSOR_SHADOW 0x00000020

Definition at line 68 of file settings_types.h.

◆ PERF_DISABLE_CURSORSETTINGS

#define PERF_DISABLE_CURSORSETTINGS 0x00000040

Definition at line 69 of file settings_types.h.

◆ PERF_DISABLE_FULLWINDOWDRAG

#define PERF_DISABLE_FULLWINDOWDRAG 0x00000002

Definition at line 65 of file settings_types.h.

◆ PERF_DISABLE_MENUANIMATIONS

#define PERF_DISABLE_MENUANIMATIONS 0x00000004

Definition at line 66 of file settings_types.h.

◆ PERF_DISABLE_THEMING

#define PERF_DISABLE_THEMING 0x00000008

Definition at line 67 of file settings_types.h.

◆ PERF_DISABLE_WALLPAPER

#define PERF_DISABLE_WALLPAPER 0x00000001

Definition at line 64 of file settings_types.h.

◆ PERF_ENABLE_DESKTOP_COMPOSITION

#define PERF_ENABLE_DESKTOP_COMPOSITION 0x00000100

Definition at line 71 of file settings_types.h.

◆ PERF_ENABLE_FONT_SMOOTHING

#define PERF_ENABLE_FONT_SMOOTHING 0x00000080

Definition at line 70 of file settings_types.h.

◆ PERF_FLAG_NONE

#define PERF_FLAG_NONE 0x00000000

Definition at line 63 of file settings_types.h.

◆ PROXY_TYPE_HTTP

#define PROXY_TYPE_HTTP 1

Definition at line 490 of file settings_types.h.

◆ PROXY_TYPE_IGNORE

#define PROXY_TYPE_IGNORE 0xFFFF

Definition at line 492 of file settings_types.h.

◆ PROXY_TYPE_NONE

#define PROXY_TYPE_NONE 0

Definition at line 489 of file settings_types.h.

◆ PROXY_TYPE_SOCKS

#define PROXY_TYPE_SOCKS 2

Definition at line 491 of file settings_types.h.

◆ RAIL_LEVEL_DOCKED_LANGBAR_SUPPORTED

#define RAIL_LEVEL_DOCKED_LANGBAR_SUPPORTED 0x00000002

Definition at line 54 of file settings_types.h.

◆ RAIL_LEVEL_HANDSHAKE_EX_SUPPORTED

#define RAIL_LEVEL_HANDSHAKE_EX_SUPPORTED 0x00000080

Definition at line 60 of file settings_types.h.

◆ RAIL_LEVEL_HIDE_MINIMIZED_APPS_SUPPORTED

#define RAIL_LEVEL_HIDE_MINIMIZED_APPS_SUPPORTED 0x00000020

Definition at line 58 of file settings_types.h.

◆ RAIL_LEVEL_LANGUAGE_IME_SYNC_SUPPORTED

#define RAIL_LEVEL_LANGUAGE_IME_SYNC_SUPPORTED 0x00000008

Definition at line 56 of file settings_types.h.

◆ RAIL_LEVEL_SERVER_TO_CLIENT_IME_SYNC_SUPPORTED

#define RAIL_LEVEL_SERVER_TO_CLIENT_IME_SYNC_SUPPORTED 0x00000010

Definition at line 57 of file settings_types.h.

◆ RAIL_LEVEL_SHELL_INTEGRATION_SUPPORTED

#define RAIL_LEVEL_SHELL_INTEGRATION_SUPPORTED 0x00000004

Definition at line 55 of file settings_types.h.

◆ RAIL_LEVEL_SUPPORTED

#define RAIL_LEVEL_SUPPORTED 0x00000001

Definition at line 53 of file settings_types.h.

◆ RAIL_LEVEL_WINDOW_CLOAKING_SUPPORTED

#define RAIL_LEVEL_WINDOW_CLOAKING_SUPPORTED 0x00000040

Definition at line 59 of file settings_types.h.

◆ REDIRECTED_SESSIONID_FIELD_VALID

#define REDIRECTED_SESSIONID_FIELD_VALID 0x00000002

Definition at line 168 of file settings_types.h.

◆ REDIRECTED_SMARTCARD

#define REDIRECTED_SMARTCARD 0x00000040

Definition at line 169 of file settings_types.h.

◆ REDIRECTION_SUPPORTED

#define REDIRECTION_SUPPORTED 0x00000001

Definition at line 167 of file settings_types.h.

◆ REDIRECTION_VERSION1

#define REDIRECTION_VERSION1 0x00

Definition at line 172 of file settings_types.h.

◆ REDIRECTION_VERSION2

#define REDIRECTION_VERSION2 0x01

Definition at line 173 of file settings_types.h.

◆ REDIRECTION_VERSION3

#define REDIRECTION_VERSION3 0x02

Definition at line 174 of file settings_types.h.

◆ REDIRECTION_VERSION4

#define REDIRECTION_VERSION4 0x03

Definition at line 175 of file settings_types.h.

◆ REDIRECTION_VERSION5

#define REDIRECTION_VERSION5 0x04

Definition at line 176 of file settings_types.h.

◆ REDIRECTION_VERSION6

#define REDIRECTION_VERSION6 0x05

Definition at line 177 of file settings_types.h.

◆ RNS_UD_15BPP_SUPPORT

#define RNS_UD_15BPP_SUPPORT 0x0004

Definition at line 138 of file settings_types.h.

◆ RNS_UD_16BPP_SUPPORT

#define RNS_UD_16BPP_SUPPORT 0x0002

Definition at line 137 of file settings_types.h.

◆ RNS_UD_24BPP_SUPPORT

#define RNS_UD_24BPP_SUPPORT 0x0001

Definition at line 136 of file settings_types.h.

◆ RNS_UD_32BPP_SUPPORT

#define RNS_UD_32BPP_SUPPORT 0x0008

Definition at line 139 of file settings_types.h.

◆ RNS_UD_COLOR_16BPP_555

#define RNS_UD_COLOR_16BPP_555 0xCA02

Definition at line 128 of file settings_types.h.

◆ RNS_UD_COLOR_16BPP_565

#define RNS_UD_COLOR_16BPP_565 0xCA03

Definition at line 129 of file settings_types.h.

◆ RNS_UD_COLOR_24BPP

#define RNS_UD_COLOR_24BPP 0xCA04

Definition at line 130 of file settings_types.h.

◆ RNS_UD_COLOR_4BPP

#define RNS_UD_COLOR_4BPP 0xCA00

Definition at line 126 of file settings_types.h.

◆ RNS_UD_COLOR_8BPP

#define RNS_UD_COLOR_8BPP 0xCA01

Definition at line 127 of file settings_types.h.

◆ RNS_UD_CS_RELATIVE_MOUSE_INPUT

#define RNS_UD_CS_RELATIVE_MOUSE_INPUT 0x0010

Definition at line 151 of file settings_types.h.

◆ RNS_UD_CS_STRONG_ASYMMETRIC_KEYS

#define RNS_UD_CS_STRONG_ASYMMETRIC_KEYS 0x0008

Definition at line 150 of file settings_types.h.

◆ RNS_UD_CS_SUPPORT_DYNAMIC_TIME_ZONE

#define RNS_UD_CS_SUPPORT_DYNAMIC_TIME_ZONE 0x0200

Definition at line 156 of file settings_types.h.

◆ RNS_UD_CS_SUPPORT_DYNVC_GFX_PROTOCOL

#define RNS_UD_CS_SUPPORT_DYNVC_GFX_PROTOCOL 0x0100

Definition at line 155 of file settings_types.h.

◆ RNS_UD_CS_SUPPORT_ERRINFO_PDU

#define RNS_UD_CS_SUPPORT_ERRINFO_PDU 0x0001

Definition at line 147 of file settings_types.h.

◆ RNS_UD_CS_SUPPORT_HEARTBEAT_PDU

#define RNS_UD_CS_SUPPORT_HEARTBEAT_PDU 0x0400

Definition at line 157 of file settings_types.h.

◆ RNS_UD_CS_SUPPORT_MONITOR_LAYOUT_PDU

#define RNS_UD_CS_SUPPORT_MONITOR_LAYOUT_PDU 0x0040

Definition at line 153 of file settings_types.h.

◆ RNS_UD_CS_SUPPORT_NETCHAR_AUTODETECT

#define RNS_UD_CS_SUPPORT_NETCHAR_AUTODETECT 0x0080

Definition at line 154 of file settings_types.h.

◆ RNS_UD_CS_SUPPORT_SKIP_CHANNELJOIN

#define RNS_UD_CS_SUPPORT_SKIP_CHANNELJOIN 0x0800

Definition at line 158 of file settings_types.h.

◆ RNS_UD_CS_SUPPORT_STATUSINFO_PDU

#define RNS_UD_CS_SUPPORT_STATUSINFO_PDU 0x0004

Definition at line 149 of file settings_types.h.

◆ RNS_UD_CS_VALID_CONNECTION_TYPE

#define RNS_UD_CS_VALID_CONNECTION_TYPE 0x0020

Definition at line 152 of file settings_types.h.

◆ RNS_UD_CS_WANT_32BPP_SESSION

#define RNS_UD_CS_WANT_32BPP_SESSION 0x0002

Definition at line 148 of file settings_types.h.

◆ RNS_UD_SAS_DEL

#define RNS_UD_SAS_DEL 0xAA03

Definition at line 133 of file settings_types.h.

◆ RNS_UD_SC_DYNAMIC_DST_SUPPORTED

#define RNS_UD_SC_DYNAMIC_DST_SUPPORTED 0x00000002

Definition at line 162 of file settings_types.h.

◆ RNS_UD_SC_EDGE_ACTIONS_SUPPORTED_V1

#define RNS_UD_SC_EDGE_ACTIONS_SUPPORTED_V1 0x00000001

Definition at line 161 of file settings_types.h.

◆ RNS_UD_SC_EDGE_ACTIONS_SUPPORTED_V2

#define RNS_UD_SC_EDGE_ACTIONS_SUPPORTED_V2 0x00000004

Definition at line 163 of file settings_types.h.

◆ RNS_UD_SC_SKIP_CHANNELJOIN_SUPPORTED

#define RNS_UD_SC_SKIP_CHANNELJOIN_SUPPORTED 0x00000008

Definition at line 164 of file settings_types.h.

◆ SC_CORE

#define SC_CORE 0x0C01

Definition at line 96 of file settings_types.h.

◆ SC_MCS_MSGCHANNEL

#define SC_MCS_MSGCHANNEL 0x0C04

Definition at line 99 of file settings_types.h.

◆ SC_MULTITRANSPORT

#define SC_MULTITRANSPORT 0x0C08

Definition at line 100 of file settings_types.h.

◆ SC_NET

#define SC_NET 0x0C03

Definition at line 98 of file settings_types.h.

◆ SC_SECURITY

#define SC_SECURITY 0x0C02

Definition at line 97 of file settings_types.h.

◆ ServerSessionRedirectionVersionMask

#define ServerSessionRedirectionVersionMask 0x0000003c

Definition at line 171 of file settings_types.h.

◆ SETTINGS_DEPRECATED

#define SETTINGS_DEPRECATED ( x ) WINPR_DEPRECATED(x)

Definition at line 45 of file settings_types_private.h.

◆ SOFTSYNC_TCP_TO_UDP

#define SOFTSYNC_TCP_TO_UDP 0x00000200

Definition at line 199 of file settings_types.h.

◆ STATUS_BRINGING_SESSION_ONLINE

#define STATUS_BRINGING_SESSION_ONLINE 0x00000403

Definition at line 315 of file settings_types.h.

◆ STATUS_FINDING_DESTINATION

#define STATUS_FINDING_DESTINATION 0x00000401

Definition at line 313 of file settings_types.h.

◆ STATUS_LOADING_DESTINATION

#define STATUS_LOADING_DESTINATION 0x00000402

Definition at line 314 of file settings_types.h.

◆ STATUS_REDIRECTING_TO_DESTINATION

#define STATUS_REDIRECTING_TO_DESTINATION 0x00000404

Definition at line 316 of file settings_types.h.

◆ STATUS_VM_BOOTING

#define STATUS_VM_BOOTING 0x00000503

Definition at line 319 of file settings_types.h.

◆ STATUS_VM_LOADING

#define STATUS_VM_LOADING 0x00000501

Definition at line 317 of file settings_types.h.

◆ STATUS_VM_WAKING

#define STATUS_VM_WAKING 0x00000502

Definition at line 318 of file settings_types.h.

◆ SURFCMDS_FRAME_MARKER

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

Definition at line 49 of file settings_types.h.

◆ SURFCMDS_SET_SURFACE_BITS

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

Definition at line 48 of file settings_types.h.

◆ SURFCMDS_STREAM_SURFACE_BITS

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

Definition at line 50 of file settings_types.h.

◆ THREADING_FLAGS_DISABLE_THREADS

#define THREADING_FLAGS_DISABLE_THREADS 0x00000001

Definition at line 495 of file settings_types.h.

◆ TRANSPORT_TYPE_UDP_FECL

#define TRANSPORT_TYPE_UDP_FECL 0x00000004

Definition at line 197 of file settings_types.h.

◆ TRANSPORT_TYPE_UDP_FECR

#define TRANSPORT_TYPE_UDP_FECR 0x00000001

Definition at line 196 of file settings_types.h.

◆ TRANSPORT_TYPE_UDP_PREFERRED

#define TRANSPORT_TYPE_UDP_PREFERRED 0x00000100

Definition at line 198 of file settings_types.h.

◆ TS_CAPS_PROTOCOLVERSION

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

Definition at line 231 of file settings_types.h.

◆ TSC_PROXY_CREDS_MODE_ANY

#define TSC_PROXY_CREDS_MODE_ANY 0x2

Definition at line 286 of file settings_types.h.

◆ TSC_PROXY_CREDS_MODE_SMARTCARD

#define TSC_PROXY_CREDS_MODE_SMARTCARD 0x1

Definition at line 285 of file settings_types.h.

◆ TSC_PROXY_CREDS_MODE_USERPASS

#define TSC_PROXY_CREDS_MODE_USERPASS 0x0

Definition at line 284 of file settings_types.h.

◆ TSC_PROXY_MODE_DEFAULT

#define TSC_PROXY_MODE_DEFAULT 0x3

Definition at line 280 of file settings_types.h.

◆ TSC_PROXY_MODE_DETECT

#define TSC_PROXY_MODE_DETECT 0x2

Definition at line 279 of file settings_types.h.

◆ TSC_PROXY_MODE_DIRECT

#define TSC_PROXY_MODE_DIRECT 0x1

Definition at line 278 of file settings_types.h.

◆ TSC_PROXY_MODE_NONE_DETECT

#define TSC_PROXY_MODE_NONE_DETECT 0x4

Definition at line 281 of file settings_types.h.

◆ TSC_PROXY_MODE_NONE_DIRECT

#define TSC_PROXY_MODE_NONE_DIRECT 0x0

Definition at line 277 of file settings_types.h.

◆ VCCAPS_COMPR_CS_8K

#define VCCAPS_COMPR_CS_8K 0x00000002

Definition at line 217 of file settings_types.h.

◆ VCCAPS_COMPR_SC

#define VCCAPS_COMPR_SC 0x00000001

Definition at line 216 of file settings_types.h.

◆ VCCAPS_NO_COMPR

#define VCCAPS_NO_COMPR 0x00000000

Definition at line 215 of file settings_types.h.

Enumeration Type Documentation

◆ FreeRDP_DesktopRotationFlags

enum FreeRDP_DesktopRotationFlags

Definition at line 329 of file settings_types.h.

{
  ORIENTATION_LANDSCAPE = 0,
  ORIENTATION_PORTRAIT = 90,

◆ FreeRDP_OrderSupportFlagConstants

enum FreeRDP_OrderSupportFlagConstants

Definition at line 234 of file settings_types.h.

  {
    NEG_DSTBLT_INDEX = 0x00,
    NEG_PATBLT_INDEX = 0x01,
    NEG_SCRBLT_INDEX = 0x02,
    NEG_MEMBLT_INDEX = 0x03,
    NEG_MEM3BLT_INDEX = 0x04,
    NEG_ATEXTOUT_INDEX = 0x05,
    NEG_AEXTTEXTOUT_INDEX = 0x06,  /* Must be ignored */
    NEG_DRAWNINEGRID_INDEX = 0x07, /* Must be ignored */
    NEG_LINETO_INDEX = 0x08,
    NEG_MULTI_DRAWNINEGRID_INDEX = 0x09,
    NEG_OPAQUE_RECT_INDEX = 0x0A, /* Must be ignored */
    NEG_SAVEBITMAP_INDEX = 0x0B,
    NEG_WTEXTOUT_INDEX = 0x0C,   /* Must be ignored */
    NEG_MEMBLT_V2_INDEX = 0x0D,  /* Must be ignored */
    NEG_MEM3BLT_V2_INDEX = 0x0E, /* Must be ignored */
    NEG_MULTIDSTBLT_INDEX = 0x0F,
    NEG_MULTIPATBLT_INDEX = 0x10,
    NEG_MULTISCRBLT_INDEX = 0x11,
    NEG_MULTIOPAQUERECT_INDEX = 0x12,
    NEG_FAST_INDEX_INDEX = 0x13,
    NEG_POLYGON_SC_INDEX = 0x14,
    NEG_POLYGON_CB_INDEX = 0x15,
    NEG_POLYLINE_INDEX = 0x16,
    NEG_UNUSED23_INDEX = 0x17, /* Must be ignored */
    NEG_FAST_GLYPH_INDEX = 0x18,
    NEG_ELLIPSE_SC_INDEX = 0x19,
    NEG_ELLIPSE_CB_INDEX = 0x1A,
    NEG_GLYPH_INDEX_INDEX = 0x1B,
    NEG_GLYPH_WEXTTEXTOUT_INDEX = 0x1C,     /* Must be ignored */
    NEG_GLYPH_WLONGTEXTOUT_INDEX = 0x1D,    /* Must be ignored */

◆ FreeRDP_RDPDR_DTYP

enum FreeRDP_RDPDR_DTYP

Definition at line 440 of file settings_types.h.

  {
    RDPDR_DTYP_SERIAL = 0x00000001,
    RDPDR_DTYP_PARALLEL = 0x00000002,
    RDPDR_DTYP_PRINT = 0x00000004,

◆ rdp_settings_type

enum rdp_settings_type

Definition at line 497 of file settings_types.h.

  {
    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_VERSION

enum RDP_VERSION

Definition at line 106 of file settings_types.h.

  {
    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,

Function Documentation

◆ freerdp_addin_argv_add_argument()

FREERDP_API BOOL freerdp_addin_argv_add_argument	(	ADDIN_ARGV *	args,
		const char *	argument
	)

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

{
  return freerdp_addin_argv_add_argument_ex(args, argument, 0);
}

◆ freerdp_addin_argv_add_argument_ex()

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

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

{
  if (!args || !argument)
    return FALSE;
 
  if (len == 0)
    len = strlen(argument);
 
  char** new_argv = (char**)realloc(
      (void*)args->argv, sizeof(char*) * (WINPR_ASSERTING_INT_CAST(uint32_t, args->argc) + 1));
 
  if (!new_argv)
    return FALSE;
 
  args->argv = new_argv;
 
  char* str = calloc(len + 1, sizeof(char));
  if (!str)
    return FALSE;
  memcpy(str, argument, len);
  args->argv[args->argc++] = str;
  return TRUE;
}

◆ freerdp_addin_argv_clone()

WINPR_ATTR_NODISCARD FREERDP_API ADDIN_ARGV * freerdp_addin_argv_clone ( const ADDIN_ARGV * args )

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

{
  union
  {
    char** c;
    const char** cc;
  } cnv;
  if (!args)
    return NULL;
  cnv.c = args->argv;
  return freerdp_addin_argv_new(WINPR_ASSERTING_INT_CAST(uint32_t, args->argc), cnv.cc);
}

◆ freerdp_addin_argv_del_argument()

FREERDP_API BOOL freerdp_addin_argv_del_argument	(	ADDIN_ARGV *	args,
		const char *	argument
	)

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

{
  if (!args || !argument)
    return FALSE;
  for (int x = 0; x < args->argc; x++)
  {
    char* arg = args->argv[x];
    if (strcmp(argument, arg) == 0)
    {
      free(arg);
      memmove_s((void*)&args->argv[x],
                (WINPR_ASSERTING_INT_CAST(uint32_t, args->argc - x)) * sizeof(char*),
                (void*)&args->argv[x + 1],
                (WINPR_ASSERTING_INT_CAST(uint32_t, args->argc - x - 1)) * sizeof(char*));
      args->argv[args->argc - 1] = NULL;
      args->argc--;
      return TRUE;
    }
  }
  return FALSE;
}

◆ freerdp_addin_argv_free()

FREERDP_API void freerdp_addin_argv_free ( ADDIN_ARGV * args )

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

{
  if (!args)
    return;
 
  if (args->argv)
  {
    for (int index = 0; index < args->argc; index++)
      free(args->argv[index]);
    free((void*)args->argv);
  }
 
  free(args);
}

◆ freerdp_addin_argv_new()

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

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

{
  if (argc > INT32_MAX)
    return NULL;
 
  ADDIN_ARGV* args = calloc(1, sizeof(ADDIN_ARGV));
  if (!args)
    return NULL;
  if (argc == 0)
    return args;
 
  args->argc = (int)argc;
  args->argv = (char**)calloc(argc, sizeof(char*));
  if (!args->argv)
    goto fail;
 
  if (argv)
  {
    for (size_t x = 0; x < argc; x++)
    {
      args->argv[x] = _strdup(argv[x]);
      if (!args->argv[x])
        goto fail;
    }
  }
  return args;
 
fail:
  WINPR_PRAGMA_DIAG_PUSH
  WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
  freerdp_addin_argv_free(args);
  WINPR_PRAGMA_DIAG_POP
  return NULL;
}

◆ freerdp_addin_replace_argument()

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

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

{
  if (!args || !previous || !argument)
    return -2;
 
  for (int i = 0; i < args->argc; i++)
  {
    if (strcmp(args->argv[i], previous) == 0)
    {
      free(args->argv[i]);
 
      if (!(args->argv[i] = _strdup(argument)))
        return -1;
 
      return 1;
    }
  }
 
  if (!freerdp_addin_argv_add_argument(args, argument))
    return -1;
  return 0;
}

◆ freerdp_addin_replace_argument_value()

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

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

{
  BOOL rc = 0;
  char* str = NULL;
  size_t length = 0;
  if (!args || !previous || !option || !value)
    return -2;
  length = strlen(option) + strlen(value) + 1;
  str = (char*)calloc(length + 1, sizeof(char));
 
  if (!str)
    return -1;
 
  (void)sprintf_s(str, length + 1, "%s:%s", option, value);
 
  for (int i = 0; i < args->argc; i++)
  {
    if (strcmp(args->argv[i], previous) == 0)
    {
      free(args->argv[i]);
      args->argv[i] = str;
      return 1;
    }
  }
 
  rc = freerdp_addin_argv_add_argument(args, str);
  free(str);
  if (!rc)
    return -1;
  return 0;
}

◆ freerdp_addin_set_argument()

FREERDP_API int freerdp_addin_set_argument	(	ADDIN_ARGV *	args,
		const char *	argument
	)

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

{
  if (!args || !argument)
    return -2;
 
  for (int i = 0; i < args->argc; i++)
  {
    if (strcmp(args->argv[i], argument) == 0)
    {
      return 1;
    }
  }
 
  if (!freerdp_addin_argv_add_argument(args, argument))
    return -1;
  return 0;
}

◆ freerdp_addin_set_argument_value()

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

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

{
  BOOL rc = 0;
  char* p = NULL;
  char* str = NULL;
  size_t length = 0;
  if (!args || !option || !value)
    return -2;
  length = strlen(option) + strlen(value) + 1;
  str = (char*)calloc(length + 1, sizeof(char));
 
  if (!str)
    return -1;
 
  (void)sprintf_s(str, length + 1, "%s:%s", option, value);
 
  for (int i = 0; i < args->argc; i++)
  {
    p = strchr(args->argv[i], ':');
 
    if (p)
    {
      if (strncmp(args->argv[i], option,
                  WINPR_ASSERTING_INT_CAST(size_t, p - args->argv[i])) == 0)
      {
        free(args->argv[i]);
        args->argv[i] = str;
        return 1;
      }
    }
  }
 
  rc = freerdp_addin_argv_add_argument(args, str);
  free(str);
  if (!rc)
    return -1;
  return 0;
}

◆ freerdp_capability_buffer_copy()

WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_capability_buffer_copy	(	rdpSettings *	settings,
		const rdpSettings *	src
	)

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

{
  WINPR_ASSERT(settings);
  WINPR_ASSERT(src);
 
  if (src->ReceivedCapabilitiesSize == 0)
    return TRUE;
 
  if (!freerdp_capability_buffer_resize(settings, src->ReceivedCapabilitiesSize, TRUE))
    return FALSE;
 
  for (UINT32 x = 0; x < src->ReceivedCapabilitiesSize; x++)
  {
    WINPR_ASSERT(settings->ReceivedCapabilities);
    settings->ReceivedCapabilities[x] = src->ReceivedCapabilities[x];
 
    WINPR_ASSERT(settings->ReceivedCapabilityDataSizes);
    settings->ReceivedCapabilityDataSizes[x] = src->ReceivedCapabilityDataSizes[x];
 
    WINPR_ASSERT(settings->ReceivedCapabilityData);
    if (src->ReceivedCapabilityDataSizes[x] > 0)
    {
      void* tmp = realloc(settings->ReceivedCapabilityData[x],
                          settings->ReceivedCapabilityDataSizes[x]);
      if (!tmp)
        return FALSE;
      memcpy(tmp, src->ReceivedCapabilityData[x], src->ReceivedCapabilityDataSizes[x]);
      settings->ReceivedCapabilityData[x] = tmp;
    }
    else
    {
      free(settings->ReceivedCapabilityData[x]);
      settings->ReceivedCapabilityData[x] = NULL;
    }
  }
  return TRUE;
}

◆ freerdp_capability_buffer_free()

FREERDP_API void freerdp_capability_buffer_free ( rdpSettings * settings )

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

{
  WINPR_ASSERT(settings);
 
  freerdp_capability_data_free(settings, 0, TRUE);
 
  free(settings->ReceivedCapabilityDataSizes);
  settings->ReceivedCapabilityDataSizes = NULL;
 
  free(settings->ReceivedCapabilities);
  settings->ReceivedCapabilities = NULL;
 
  settings->ReceivedCapabilitiesSize = 0;
}

◆ freerdp_device_clone()

WINPR_ATTR_NODISCARD FREERDP_API RDPDR_DEVICE * freerdp_device_clone ( const RDPDR_DEVICE * device )

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

{
  union
  {
    const RDPDR_DEVICE* dev;
    const RDPDR_DRIVE* drive;
    const RDPDR_SERIAL* serial;
    const RDPDR_PRINTER* printer;
    const RDPDR_PARALLEL* parallel;
    const RDPDR_SMARTCARD* smartcard;
  } src;
 
  union
  {
    RDPDR_DEVICE* dev;
    RDPDR_DRIVE* drive;
    RDPDR_SERIAL* serial;
    RDPDR_PRINTER* printer;
    RDPDR_PARALLEL* parallel;
    RDPDR_SMARTCARD* smartcard;
  } copy;
  size_t count = 0;
  const char* args[4] = { 0 };
 
  copy.dev = NULL;
  src.dev = device;
 
  if (!device)
    return NULL;
 
  if (device->Name)
  {
    args[count++] = device->Name;
  }
 
  switch (device->Type)
  {
    case RDPDR_DTYP_FILESYSTEM:
      if (src.drive->Path)
      {
        args[count++] = src.drive->Path;
        args[count++] = src.drive->automount ? NULL : src.drive->Path;
      }
      break;
 
    case RDPDR_DTYP_PRINT:
      if (src.printer->DriverName)
        args[count++] = src.printer->DriverName;
      break;
 
    case RDPDR_DTYP_SMARTCARD:
      break;
 
    case RDPDR_DTYP_SERIAL:
      if (src.serial->Path)
        args[count++] = src.serial->Path;
 
      if (src.serial->Driver)
        args[count++] = src.serial->Driver;
 
      if (src.serial->Permissive)
        args[count++] = src.serial->Permissive;
      break;
 
    case RDPDR_DTYP_PARALLEL:
      if (src.parallel->Path)
        args[count++] = src.parallel->Path;
      break;
    default:
      WLog_ERR(TAG, "unknown device type %" PRIu32 "", device->Type);
      break;
  }
 
  copy.dev = freerdp_device_new(device->Type, count, args);
  if (!copy.dev)
    return NULL;
 
  copy.dev->Id = device->Id;
 
  return copy.dev;
}

◆ freerdp_device_collection_add()

FREERDP_API BOOL freerdp_device_collection_add	(	rdpSettings *	settings,
		RDPDR_DEVICE *	device
	)

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

{
  UINT32 count = 0;
  UINT32 old = 0;
  WINPR_ASSERT(settings);
  WINPR_ASSERT(device);
 
  count = freerdp_settings_get_uint32(settings, FreeRDP_DeviceCount) + 1;
  old = freerdp_settings_get_uint32(settings, FreeRDP_DeviceArraySize);
  if (old < count)
  {
    const size_t new_size = (old + 32);
    RDPDR_DEVICE** new_array =
        (RDPDR_DEVICE**)realloc((void*)settings->DeviceArray, new_size * sizeof(RDPDR_DEVICE*));
 
    if (!new_array)
      return FALSE;
 
    settings->DeviceArray = new_array;
    for (size_t x = old; x < new_size; x++)
      settings->DeviceArray[x] = NULL;
 
    if (!freerdp_settings_set_uint32(settings, FreeRDP_DeviceArraySize,
                                     WINPR_ASSERTING_INT_CAST(uint32_t, new_size)))
      return FALSE;
  }
 
  settings->DeviceArray[settings->DeviceCount++] = device;
  return TRUE;
}

◆ 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_device_collection_find()

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

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

{
  RDPDR_DEVICE* device = NULL;
 
  WINPR_ASSERT(settings);
  WINPR_ASSERT(name);
  for (UINT32 index = 0; index < settings->DeviceCount; index++)
  {
    device = settings->DeviceArray[index];
 
    if (!device->Name)
      continue;
 
    if (strcmp(device->Name, name) == 0)
      return device;
  }
 
  return NULL;
}

◆ freerdp_device_collection_find_type()

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

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

{
  RDPDR_DEVICE* device = NULL;
  WINPR_ASSERT(settings);
 
  for (UINT32 index = 0; index < settings->DeviceCount; index++)
  {
    device = settings->DeviceArray[index];
 
    if (device->Type == type)
      return device;
  }
 
  return NULL;
}

◆ freerdp_device_collection_free()

FREERDP_API void freerdp_device_collection_free ( rdpSettings * settings )

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

{
  WINPR_ASSERT(settings);
 
  if (settings->DeviceArray)
  {
    for (UINT32 index = 0; index < settings->DeviceArraySize; index++)
      (void)freerdp_settings_set_pointer_array(settings, FreeRDP_DeviceArray, index, NULL);
  }
 
  free((void*)settings->DeviceArray);
 
  (void)freerdp_settings_set_pointer(settings, FreeRDP_DeviceArray, NULL);
  (void)freerdp_settings_set_uint32(settings, FreeRDP_DeviceArraySize, 0);
  (void)freerdp_settings_set_uint32(settings, FreeRDP_DeviceCount, 0);
}

◆ freerdp_device_equal()

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

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

{
  if (!what && !expect)
    return TRUE;
  if (!what || !expect)
    return FALSE;
 
  if (what->Id != expect->Id)
    return FALSE;
  if (what->Type != expect->Type)
    return FALSE;
  if (what->Name && expect->Name)
  {
    if (strcmp(what->Name, expect->Name) != 0)
      return FALSE;
  }
  else
  {
    if (what->Name != expect->Name)
      return FALSE;
  }
 
  switch (what->Type)
  {
    case RDPDR_DTYP_PRINT:
    {
      const RDPDR_PRINTER* a = (const RDPDR_PRINTER*)what;
      const RDPDR_PRINTER* b = (const RDPDR_PRINTER*)expect;
      if (a->DriverName && b->DriverName)
        return strcmp(a->DriverName, b->DriverName) == 0;
      return a->DriverName == b->DriverName;
    }
 
    case RDPDR_DTYP_SERIAL:
    {
      const RDPDR_SERIAL* a = (const RDPDR_SERIAL*)what;
      const RDPDR_SERIAL* b = (const RDPDR_SERIAL*)expect;
 
      if (a->Path && b->Path)
      {
        if (strcmp(a->Path, b->Path) != 0)
          return FALSE;
      }
      else if (a->Path != b->Path)
        return FALSE;
 
      if (a->Driver && b->Driver)
      {
        if (strcmp(a->Driver, b->Driver) != 0)
          return FALSE;
      }
      else if (a->Driver != b->Driver)
        return FALSE;
      if (a->Permissive && b->Permissive)
        return strcmp(a->Permissive, b->Permissive) == 0;
      return a->Permissive == b->Permissive;
    }
 
    case RDPDR_DTYP_PARALLEL:
    {
      const RDPDR_PARALLEL* a = (const RDPDR_PARALLEL*)what;
      const RDPDR_PARALLEL* b = (const RDPDR_PARALLEL*)expect;
      if (a->Path && b->Path)
        return strcmp(a->Path, b->Path) == 0;
      return a->Path == b->Path;
    }
 
    case RDPDR_DTYP_SMARTCARD:
      break;
    case RDPDR_DTYP_FILESYSTEM:
    {
      const RDPDR_DRIVE* a = (const RDPDR_DRIVE*)what;
      const RDPDR_DRIVE* b = (const RDPDR_DRIVE*)expect;
      if (a->automount != b->automount)
        return FALSE;
      if (a->Path && b->Path)
        return strcmp(a->Path, b->Path) == 0;
      return a->Path == b->Path;
    }
 
    default:
      return FALSE;
  }
 
  return TRUE;
}

◆ freerdp_device_free()

FREERDP_API void freerdp_device_free ( RDPDR_DEVICE * device )

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

{
  if (!device)
    return;
 
  union
  {
    RDPDR_DEVICE* dev;
    RDPDR_DRIVE* drive;
    RDPDR_SERIAL* serial;
    RDPDR_PRINTER* printer;
    RDPDR_PARALLEL* parallel;
    RDPDR_SMARTCARD* smartcard;
  } cnv;
 
  cnv.dev = device;
 
  switch (device->Type)
  {
    case RDPDR_DTYP_PRINT:
      free(cnv.printer->DriverName);
      break;
    case RDPDR_DTYP_SERIAL:
      free(cnv.serial->Path);
      free(cnv.serial->Driver);
      free(cnv.serial->Permissive);
      break;
    case RDPDR_DTYP_PARALLEL:
      free(cnv.parallel->Path);
      break;
    case RDPDR_DTYP_SMARTCARD:
      break;
    case RDPDR_DTYP_FILESYSTEM:
      free(cnv.drive->Path);
      break;
    default:
      break;
  }
  free(cnv.dev->Name);
  free(cnv.dev);
}

◆ freerdp_device_new()

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

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

{
  size_t size = 0;
  union
  {
    RDPDR_DEVICE* base;
    RDPDR_DRIVE* drive;
    RDPDR_SERIAL* serial;
    RDPDR_PRINTER* printer;
    RDPDR_PARALLEL* parallel;
    RDPDR_SMARTCARD* smartcard;
  } device;
 
  device.base = NULL;
  WINPR_ASSERT(args || (count == 0));
 
  switch (Type)
  {
    case RDPDR_DTYP_PRINT:
      size = sizeof(RDPDR_PRINTER);
      break;
    case RDPDR_DTYP_SERIAL:
      size = sizeof(RDPDR_SERIAL);
      break;
    case RDPDR_DTYP_PARALLEL:
      size = sizeof(RDPDR_PARALLEL);
      break;
    case RDPDR_DTYP_SMARTCARD:
      size = sizeof(RDPDR_SMARTCARD);
      break;
    case RDPDR_DTYP_FILESYSTEM:
      size = sizeof(RDPDR_DRIVE);
      break;
    default:
      goto fail;
  }
 
  device.base = calloc(1, size);
  if (!device.base)
    goto fail;
  device.base->Id = 0;
  device.base->Type = Type;
 
  if (count > 0)
  {
    device.base->Name = _strdup(args[0]);
    if (!device.base->Name)
      goto fail;
 
    switch (Type)
    {
      case RDPDR_DTYP_PRINT:
        if (count > 1)
        {
          device.printer->DriverName = _strdup(args[1]);
          if (!device.printer->DriverName)
            goto fail;
        }
 
        if (count > 2)
        {
          device.printer->IsDefault = _stricmp(args[2], "default") == 0;
        }
        break;
      case RDPDR_DTYP_SERIAL:
        if (count > 1)
        {
          device.serial->Path = _strdup(args[1]);
          if (!device.serial->Path)
            goto fail;
        }
 
        if (count > 2)
        {
          device.serial->Driver = _strdup(args[2]);
          if (!device.serial->Driver)
            goto fail;
        }
 
        if (count > 3)
        {
          device.serial->Permissive = _strdup(args[3]);
          if (!device.serial->Permissive)
            goto fail;
        }
        break;
      case RDPDR_DTYP_PARALLEL:
        if (count > 1)
        {
          device.parallel->Path = _strdup(args[1]);
          if (!device.serial->Path)
            goto fail;
        }
        break;
      case RDPDR_DTYP_SMARTCARD:
        break;
      case RDPDR_DTYP_FILESYSTEM:
        if (count > 1)
        {
          device.drive->Path = _strdup(args[1]);
          if (!device.drive->Path)
            goto fail;
        }
        if (count > 2)
          device.drive->automount = (args[2] == NULL) ? TRUE : FALSE;
        break;
      default:
        goto fail;
    }
  }
  return device.base;
 
fail:
  freerdp_device_free(device.base);
  return NULL;
}

◆ freerdp_dynamic_channel_collection_add()

FREERDP_API BOOL freerdp_dynamic_channel_collection_add	(	rdpSettings *	settings,
		ADDIN_ARGV *	channel
	)

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

{
  UINT32 count = 0;
  UINT32 oldSize = 0;
 
  WINPR_ASSERT(settings);
  WINPR_ASSERT(channel);
 
  count = freerdp_settings_get_uint32(settings, FreeRDP_DynamicChannelCount) + 1;
  oldSize = freerdp_settings_get_uint32(settings, FreeRDP_DynamicChannelArraySize);
  if (oldSize < count)
  {
 
    const size_t size = oldSize + 32;
    ADDIN_ARGV** new_array =
        (ADDIN_ARGV**)realloc((void*)settings->DynamicChannelArray, sizeof(ADDIN_ARGV*) * size);
 
    if (!new_array)
      return FALSE;
 
    settings->DynamicChannelArray = new_array;
    {
      for (size_t x = oldSize; x < size; x++)
        settings->DynamicChannelArray[x] = NULL;
    }
    if (!freerdp_settings_set_uint32(settings, FreeRDP_DynamicChannelArraySize,
                                     WINPR_ASSERTING_INT_CAST(uint32_t, size)))
      return FALSE;
  }
 
  count = freerdp_settings_get_uint32(settings, FreeRDP_DynamicChannelCount);
  settings->DynamicChannelArray[count++] = channel;
  return freerdp_settings_set_uint32(settings, FreeRDP_DynamicChannelCount, count);
}

◆ freerdp_dynamic_channel_collection_del()

FREERDP_API BOOL freerdp_dynamic_channel_collection_del	(	rdpSettings *	settings,
		const char *	name
	)

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

{
  const UINT32 count = freerdp_settings_get_uint32(settings, FreeRDP_DynamicChannelCount);
  if (!settings || !settings->DynamicChannelArray)
    return FALSE;
 
  for (UINT32 x = 0; x < count; x++)
  {
    ADDIN_ARGV* cur = settings->DynamicChannelArray[x];
    if (cur && (cur->argc > 0))
    {
      if (strcmp(name, cur->argv[0]) == 0)
      {
        memmove_s((void*)&settings->DynamicChannelArray[x],
                  (count - x) * sizeof(ADDIN_ARGV*),
                  (void*)&settings->DynamicChannelArray[x + 1],
                  (count - x - 1) * sizeof(ADDIN_ARGV*));
        for (size_t y = count - 1; y < settings->DynamicChannelArraySize; y++)
          settings->DynamicChannelArray[y] = NULL;
 
        freerdp_addin_argv_free(cur);
        return freerdp_settings_set_uint32(settings, FreeRDP_DynamicChannelCount,
                                           count - 1);
      }
    }
  }
 
  return FALSE;
}

◆ freerdp_dynamic_channel_collection_find()

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

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

{
  WINPR_ASSERT(settings);
  WINPR_ASSERT(name);
 
  for (UINT32 index = 0;
       index < freerdp_settings_get_uint32(settings, FreeRDP_DynamicChannelCount); index++)
  {
    ADDIN_ARGV* channel = settings->DynamicChannelArray[index];
 
    if (strcmp(channel->argv[0], name) == 0)
      return channel;
  }
 
  return NULL;
}

◆ freerdp_dynamic_channel_collection_free()

FREERDP_API void freerdp_dynamic_channel_collection_free ( rdpSettings * settings )

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

{
  WINPR_ASSERT(settings);
 
  if (settings->DynamicChannelArray)
  {
    for (UINT32 i = 0;
         i < freerdp_settings_get_uint32(settings, FreeRDP_DynamicChannelArraySize); i++)
      freerdp_addin_argv_free(settings->DynamicChannelArray[i]);
  }
 
  free((void*)settings->DynamicChannelArray);
  (void)freerdp_settings_set_uint32(settings, FreeRDP_DynamicChannelArraySize, 0);
  settings->DynamicChannelArray = NULL;
  (void)freerdp_settings_set_uint32(settings, FreeRDP_DynamicChannelCount, 0);
}

◆ freerdp_encryption_level_string()

WINPR_ATTR_NODISCARD FREERDP_API const char * freerdp_encryption_level_string ( UINT32 EncryptionLevel )

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

{
  switch (EncryptionLevel)
  {
    case ENCRYPTION_LEVEL_NONE:
      return "ENCRYPTION_LEVEL_NONE";
    case ENCRYPTION_LEVEL_LOW:
      return "ENCRYPTION_LEVEL_LOW";
    case ENCRYPTION_LEVEL_CLIENT_COMPATIBLE:
      return "ENCRYPTION_LEVEL_CLIENT_COMPATIBLE";
    case ENCRYPTION_LEVEL_HIGH:
      return "ENCRYPTION_LEVEL_HIGH";
    case ENCRYPTION_LEVEL_FIPS:
      return "ENCRYPTION_LEVEL_FIPS";
    default:
      return "ENCRYPTION_LEVEL_UNKNOWN";
  }
}

◆ freerdp_encryption_methods_string()

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

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

{
  if (EncryptionMethods == ENCRYPTION_METHOD_NONE)
  {
    winpr_str_append("ENCRYPTION_METHOD_NONE", buffer, size, "|");
    return buffer;
  }
 
  if (EncryptionMethods & ENCRYPTION_METHOD_40BIT)
  {
    winpr_str_append("ENCRYPTION_METHOD_40BIT", buffer, size, "|");
  }
  if (EncryptionMethods & ENCRYPTION_METHOD_128BIT)
  {
    winpr_str_append("ENCRYPTION_METHOD_128BIT", buffer, size, "|");
  }
  if (EncryptionMethods & ENCRYPTION_METHOD_56BIT)
  {
    winpr_str_append("ENCRYPTION_METHOD_56BIT", buffer, size, "|");
  }
  if (EncryptionMethods & ENCRYPTION_METHOD_FIPS)
  {
    winpr_str_append("ENCRYPTION_METHOD_FIPS", buffer, size, "|");
  }
 
  return buffer;
}

◆ freerdp_performance_flags_make()

FREERDP_API void freerdp_performance_flags_make ( rdpSettings * settings )

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

{
  UINT32 PerformanceFlags = PERF_FLAG_NONE;
 
  if (freerdp_settings_get_bool(settings, FreeRDP_AllowFontSmoothing))
    PerformanceFlags |= PERF_ENABLE_FONT_SMOOTHING;
 
  if (freerdp_settings_get_bool(settings, FreeRDP_AllowDesktopComposition))
    PerformanceFlags |= PERF_ENABLE_DESKTOP_COMPOSITION;
 
  if (freerdp_settings_get_bool(settings, FreeRDP_DisableWallpaper))
    PerformanceFlags |= PERF_DISABLE_WALLPAPER;
 
  if (freerdp_settings_get_bool(settings, FreeRDP_DisableFullWindowDrag))
    PerformanceFlags |= PERF_DISABLE_FULLWINDOWDRAG;
 
  if (freerdp_settings_get_bool(settings, FreeRDP_DisableMenuAnims))
    PerformanceFlags |= PERF_DISABLE_MENUANIMATIONS;
 
  if (freerdp_settings_get_bool(settings, FreeRDP_DisableThemes))
    PerformanceFlags |= PERF_DISABLE_THEMING;
  (void)freerdp_settings_set_uint32(settings, FreeRDP_PerformanceFlags, PerformanceFlags);
}

◆ freerdp_performance_flags_split()

FREERDP_API void freerdp_performance_flags_split ( rdpSettings * settings )

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

{
  (void)freerdp_settings_set_bool(
      settings, FreeRDP_AllowFontSmoothing,
      (freerdp_settings_get_uint32(settings, FreeRDP_PerformanceFlags) &
       PERF_ENABLE_FONT_SMOOTHING)
          ? TRUE
          : FALSE);
  (void)freerdp_settings_set_bool(
      settings, FreeRDP_AllowDesktopComposition,
      (freerdp_settings_get_uint32(settings, FreeRDP_PerformanceFlags) &
       PERF_ENABLE_DESKTOP_COMPOSITION)
          ? TRUE
          : FALSE);
  (void)freerdp_settings_set_bool(
      settings, FreeRDP_DisableWallpaper,
      (freerdp_settings_get_uint32(settings, FreeRDP_PerformanceFlags) & PERF_DISABLE_WALLPAPER)
          ? TRUE
          : FALSE);
  (void)freerdp_settings_set_bool(
      settings, FreeRDP_DisableFullWindowDrag,
      (freerdp_settings_get_uint32(settings, FreeRDP_PerformanceFlags) &
       PERF_DISABLE_FULLWINDOWDRAG)
          ? TRUE
          : FALSE);
  (void)freerdp_settings_set_bool(
      settings, FreeRDP_DisableMenuAnims,
      (freerdp_settings_get_uint32(settings, FreeRDP_PerformanceFlags) &
       PERF_DISABLE_MENUANIMATIONS)
          ? TRUE
          : FALSE);
  (void)freerdp_settings_set_bool(
      settings, FreeRDP_DisableThemes,
      (freerdp_settings_get_uint32(settings, FreeRDP_PerformanceFlags) & PERF_DISABLE_THEMING)
          ? TRUE
          : FALSE);
}

◆ freerdp_rail_support_flags_to_string()

WINPR_ATTR_NODISCARD 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 2156 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()

WINPR_ATTR_NODISCARD 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 2218 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()

WINPR_ATTR_NODISCARD 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 2308 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_server_license_issuers_copy()

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

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

{
  WINPR_ASSERT(settings);
  WINPR_ASSERT(issuers || (count == 0));
 
  if (!freerdp_settings_set_pointer_len(settings, FreeRDP_ServerLicenseProductIssuers, NULL,
                                        count))
    return FALSE;
 
  for (UINT32 x = 0; x < count; x++)
  {
    char* issuer = _strdup(issuers[x]);
    if (!issuer)
      return FALSE;
    settings->ServerLicenseProductIssuers[x] = issuer;
  }
 
  return TRUE;
}

◆ freerdp_server_license_issuers_free()

FREERDP_API void freerdp_server_license_issuers_free ( rdpSettings * settings )

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

{
  WINPR_ASSERT(settings);
 
  if (settings->ServerLicenseProductIssuers)
  {
    for (UINT32 x = 0; x < settings->ServerLicenseProductIssuersCount; x++)
      free(settings->ServerLicenseProductIssuers[x]);
  }
  free((void*)settings->ServerLicenseProductIssuers);
  settings->ServerLicenseProductIssuers = NULL;
  settings->ServerLicenseProductIssuersCount = 0;
}

◆ 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 1126 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_bool(), and 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 2399 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()

WINPR_ATTR_NODISCARD 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 2419 of file common/settings.c.

{
  return settings != NULL;
}

◆ freerdp_settings_clone()

WINPR_ATTR_NODISCARD 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 1535 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:
  WINPR_PRAGMA_DIAG_PUSH
  WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
  freerdp_settings_free(_settings);
  WINPR_PRAGMA_DIAG_POP
  return NULL;
}

References freerdp_settings_copy(), and freerdp_settings_free().

Here is the call graph for this function:

◆ freerdp_settings_copy()

WINPR_ATTR_NODISCARD 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 1509 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);
  if (!rc)
    goto out_fail;
  freerdp_settings_free_internal_ensure_reset(_settings);
 
  /* 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()

WINPR_ATTR_NODISCARD 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 432 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_deserialize()

WINPR_ATTR_NODISCARD FREERDP_API rdpSettings * freerdp_settings_deserialize	(	const char *	json,
		size_t	length
	)

A function that converts a JSON string to a rdpSettings struct.

Parameters

json	The JSON string
length	The strlen of the JSON string

Returns: An allocated rdpSettings struct or NULL in case of an error

Since: version 3.16.0

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

{
  WINPR_JSON* json = WINPR_JSON_ParseWithLength(jstr, length);
  if (!json)
    return NULL;
 
  WINPR_JSON* jbool = WINPR_JSON_GetObjectItemCaseSensitive(
      json, freerdp_settings_get_type_name_for_type(RDP_SETTINGS_TYPE_BOOL));
  WINPR_JSON* juint16 = WINPR_JSON_GetObjectItemCaseSensitive(
      json, freerdp_settings_get_type_name_for_type(RDP_SETTINGS_TYPE_UINT16));
  WINPR_JSON* jint16 = WINPR_JSON_GetObjectItemCaseSensitive(
      json, freerdp_settings_get_type_name_for_type(RDP_SETTINGS_TYPE_INT16));
  WINPR_JSON* juint32 = WINPR_JSON_GetObjectItemCaseSensitive(
      json, freerdp_settings_get_type_name_for_type(RDP_SETTINGS_TYPE_UINT32));
  WINPR_JSON* jint32 = WINPR_JSON_GetObjectItemCaseSensitive(
      json, freerdp_settings_get_type_name_for_type(RDP_SETTINGS_TYPE_INT32));
  WINPR_JSON* juint64 = WINPR_JSON_GetObjectItemCaseSensitive(
      json, freerdp_settings_get_type_name_for_type(RDP_SETTINGS_TYPE_UINT64));
  WINPR_JSON* jint64 = WINPR_JSON_GetObjectItemCaseSensitive(
      json, freerdp_settings_get_type_name_for_type(RDP_SETTINGS_TYPE_INT64));
  WINPR_JSON* jstring = WINPR_JSON_GetObjectItemCaseSensitive(
      json, freerdp_settings_get_type_name_for_type(RDP_SETTINGS_TYPE_STRING));
  WINPR_JSON* jpointer = WINPR_JSON_GetObjectItemCaseSensitive(
      json, freerdp_settings_get_type_name_for_type(RDP_SETTINGS_TYPE_POINTER));
 
  rdpSettings* settings = freerdp_settings_new(0);
  if (!settings)
    goto fail;
  if (!jbool || !juint16 || !jint16 || !juint32 || !jint32 || !juint64 || !jint64 || !jstring ||
      !jpointer)
    goto fail;
 
  for (int x = 0; x < FreeRDP_Settings_StableAPI_MAX; x++)
  {
    union
    {
 
      int s;
      FreeRDP_Settings_Keys_Bool b;
      FreeRDP_Settings_Keys_Int16 i16;
      FreeRDP_Settings_Keys_UInt16 u16;
      FreeRDP_Settings_Keys_Int32 i32;
      FreeRDP_Settings_Keys_UInt32 u32;
      FreeRDP_Settings_Keys_Int64 i64;
      FreeRDP_Settings_Keys_UInt64 u64;
      FreeRDP_Settings_Keys_String str;
      FreeRDP_Settings_Keys_Pointer ptr;
    } iter;
    iter.s = x;
 
    SSIZE_T type = freerdp_settings_get_type_for_key(iter.s);
    switch (type)
    {
      case RDP_SETTINGS_TYPE_POINTER:
        if (!deserialize_pointer(jpointer, settings, iter.ptr))
          goto fail;
        break;
      default:
        break;
    }
  }
 
  for (int x = 0; x < FreeRDP_Settings_StableAPI_MAX; x++)
  {
    union
    {
 
      int s;
      FreeRDP_Settings_Keys_Bool b;
      FreeRDP_Settings_Keys_Int16 i16;
      FreeRDP_Settings_Keys_UInt16 u16;
      FreeRDP_Settings_Keys_Int32 i32;
      FreeRDP_Settings_Keys_UInt32 u32;
      FreeRDP_Settings_Keys_Int64 i64;
      FreeRDP_Settings_Keys_UInt64 u64;
      FreeRDP_Settings_Keys_String str;
      FreeRDP_Settings_Keys_Pointer ptr;
    } iter;
    iter.s = x;
 
    const char* name = freerdp_settings_get_name_for_key(iter.s);
    SSIZE_T type = freerdp_settings_get_type_for_key(iter.s);
    switch (type)
    {
      case RDP_SETTINGS_TYPE_BOOL:
      {
        WINPR_JSON* item = WINPR_JSON_GetObjectItemCaseSensitive(jbool, name);
        if (!item)
          goto fail;
        if (!WINPR_JSON_IsBool(item))
          goto fail;
        const BOOL val = WINPR_JSON_IsTrue(item);
        if (!freerdp_settings_set_bool(settings, iter.b, val))
          goto fail;
      }
      break;
      case RDP_SETTINGS_TYPE_UINT16:
      {
        WINPR_JSON* item = WINPR_JSON_GetObjectItemCaseSensitive(juint16, name);
        const uint16_t val = (uint16_t)uint_from_json_item(item, UINT16_MAX);
        if (errno != 0)
          goto fail;
        if (!freerdp_settings_set_uint16(settings, iter.u16, val))
          goto fail;
      }
      break;
      case RDP_SETTINGS_TYPE_INT16:
      {
        WINPR_JSON* item = WINPR_JSON_GetObjectItemCaseSensitive(jint16, name);
        const int16_t val = (int16_t)int_from_json_item(item, INT16_MIN, INT16_MAX);
        if (errno != 0)
          goto fail;
        if (!freerdp_settings_set_int16(settings, iter.i16, val))
          goto fail;
      }
      break;
      case RDP_SETTINGS_TYPE_UINT32:
      {
        WINPR_JSON* item = WINPR_JSON_GetObjectItemCaseSensitive(juint32, name);
        const uint32_t val = (uint32_t)uint_from_json_item(item, UINT32_MAX);
        if (errno != 0)
          goto fail;
        if (!freerdp_settings_set_uint32(settings, iter.u32, val))
          goto fail;
      }
      break;
      case RDP_SETTINGS_TYPE_INT32:
      {
        const int64_t val = int_from_json(jint32, name, INT32_MIN, INT32_MAX);
        if (errno != 0)
          goto fail;
        if (!freerdp_settings_set_int32(settings, iter.i32, (int32_t)val))
          goto fail;
      }
      break;
      case RDP_SETTINGS_TYPE_UINT64:
      {
        const uint64_t val = uint_from_json(juint64, name, UINT64_MAX);
        if (errno != 0)
          goto fail;
        if (!freerdp_settings_set_uint64(settings, iter.u64, val))
          goto fail;
      }
      break;
      case RDP_SETTINGS_TYPE_INT64:
      {
        WINPR_JSON* item = WINPR_JSON_GetObjectItemCaseSensitive(jint64, name);
        const int64_t val = int_from_json_item(item, INT64_MIN, INT64_MAX);
        if (errno != 0)
          goto fail;
        if (!freerdp_settings_set_int64(settings, iter.i64, val))
          goto fail;
      }
      break;
      case RDP_SETTINGS_TYPE_STRING:
      {
        const char* val = NULL;
        WINPR_JSON* item = WINPR_JSON_GetObjectItemCaseSensitive(jstring, name);
        if (item && !WINPR_JSON_IsNull(item))
        {
          if (!WINPR_JSON_IsString(item))
            goto fail;
          val = WINPR_JSON_GetStringValue(item);
          if (!val)
            goto fail;
        }
        if (!freerdp_settings_set_string(settings, iter.str, val))
          goto fail;
      }
      break;
      case RDP_SETTINGS_TYPE_POINTER:
      default:
        break;
    }
  }
 
  WINPR_JSON_Delete(json);
  return settings;
 
fail:
  freerdp_settings_free(settings);
  WINPR_JSON_Delete(json);
  return NULL;
}

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 249 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;
      default:
        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 1288 of file core/settings.c.

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

Referenced by freerdp_settings_clone(), freerdp_settings_deserialize(), and freerdp_settings_new().

Here is the caller graph for this function:

◆ freerdp_settings_get_bool()

WINPR_ATTR_NODISCARD 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

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

Here is the caller graph for this function:

◆ freerdp_settings_get_codecs_flags()

WINPR_ATTR_NODISCARD 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 2010 of file common/settings.c.

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

◆ freerdp_settings_get_config_path()

WINPR_ATTR_NODISCARD 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

Note: Since 3.17.1 this is a wrapper for freerdp_GetConfigFilePath(FALSE, "")

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

{
  return freerdp_GetConfigFilePath(FALSE, "");
}

Referenced by freerdp_settings_new().

Here is the caller graph for this function:

◆ freerdp_settings_get_int16()

WINPR_ATTR_NODISCARD 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

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

Here is the caller graph for this function:

◆ freerdp_settings_get_int32()

WINPR_ATTR_NODISCARD 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

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

Here is the caller graph for this function:

◆ freerdp_settings_get_int64()

WINPR_ATTR_NODISCARD 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

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

Here is the caller graph for this function:

◆ freerdp_settings_get_key_for_name()

WINPR_ATTR_NODISCARD 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 351 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()

WINPR_ATTR_NODISCARD 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 421 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;
}

Referenced by freerdp_settings_deserialize(), freerdp_settings_get_pointer_writable(), freerdp_settings_get_string_writable(), and freerdp_settings_serialize().

Here is the caller graph for this function:

◆ freerdp_settings_get_pointer()

WINPR_ATTR_NODISCARD 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 1430 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_array()

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

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

{
  return freerdp_settings_get_pointer_array_writable(settings, id, offset);
}

◆ freerdp_settings_get_pointer_array_writable()

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

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

{
  size_t max = 0;
  if (!settings)
    return NULL;
  switch (id)
  {
    case FreeRDP_ClientAutoReconnectCookie:
      max = 1;
      if ((offset >= max) || !settings->ClientAutoReconnectCookie)
        goto fail;
      return &settings->ClientAutoReconnectCookie[offset];
    case FreeRDP_ServerAutoReconnectCookie:
      max = 1;
      if ((offset >= max) || !settings->ServerAutoReconnectCookie)
        goto fail;
      return &settings->ServerAutoReconnectCookie[offset];
    case FreeRDP_ServerCertificate:
      max = freerdp_settings_get_uint32(settings, FreeRDP_ServerCertificateLength);
      if (offset >= max)
        goto fail;
      return &settings->ServerCertificate[offset];
    case FreeRDP_ServerRandom:
      max = freerdp_settings_get_uint32(settings, FreeRDP_ServerRandomLength);
      if (offset >= max)
        goto fail;
      return &settings->ServerRandom[offset];
    case FreeRDP_ClientRandom:
      max = freerdp_settings_get_uint32(settings, FreeRDP_ClientRandomLength);
      if (offset >= max)
        goto fail;
      return &settings->ClientRandom[offset];
    case FreeRDP_LoadBalanceInfo:
      max = freerdp_settings_get_uint32(settings, FreeRDP_LoadBalanceInfoLength);
      if (offset >= max)
        goto fail;
      return &settings->LoadBalanceInfo[offset];
 
    case FreeRDP_RedirectionTsvUrl:
      max = freerdp_settings_get_uint32(settings, FreeRDP_RedirectionTsvUrlLength);
      if (offset >= max)
        goto fail;
      return &settings->RedirectionTsvUrl[offset];
 
    case FreeRDP_RedirectionPassword:
      max = freerdp_settings_get_uint32(settings, FreeRDP_RedirectionPasswordLength);
      if (offset >= max)
        goto fail;
      return &settings->RedirectionPassword[offset];
 
    case FreeRDP_OrderSupport:
      max = 32;
      if (offset >= max)
        goto fail;
      return &settings->OrderSupport[offset];
    case FreeRDP_MonitorIds:
      max = freerdp_settings_get_uint32(settings, FreeRDP_NumMonitorIds);
      if (offset >= max)
        goto fail;
      return &settings->MonitorIds[offset];
    case FreeRDP_MonitorDefArray:
      max = freerdp_settings_get_uint32(settings, FreeRDP_MonitorDefArraySize);
      if (offset >= max)
        goto fail;
      return &settings->MonitorDefArray[offset];
    case FreeRDP_ChannelDefArray:
      max = freerdp_settings_get_uint32(settings, FreeRDP_ChannelDefArraySize);
      if (offset >= max)
        goto fail;
      return &settings->ChannelDefArray[offset];
    case FreeRDP_DeviceArray:
      max = freerdp_settings_get_uint32(settings, FreeRDP_DeviceArraySize);
      if (offset >= max)
        goto fail;
      return settings->DeviceArray[offset];
    case FreeRDP_StaticChannelArray:
      max = freerdp_settings_get_uint32(settings, FreeRDP_StaticChannelArraySize);
      if (offset >= max)
        goto fail;
      return settings->StaticChannelArray[offset];
    case FreeRDP_DynamicChannelArray:
      max = freerdp_settings_get_uint32(settings, FreeRDP_DynamicChannelArraySize);
      if (offset >= max)
        goto fail;
      return settings->DynamicChannelArray[offset];
    case FreeRDP_FragCache:
      max = 1;
      if (offset >= max)
        goto fail;
      return &settings->FragCache[offset];
    case FreeRDP_GlyphCache:
      max = 10;
      if (offset >= max)
        goto fail;
      return &settings->GlyphCache[offset];
    case FreeRDP_BitmapCacheV2CellInfo:
      max = freerdp_settings_get_uint32(settings, FreeRDP_BitmapCacheV2NumCells);
      if (offset >= max)
        goto fail;
      return &settings->BitmapCacheV2CellInfo[offset];
    case FreeRDP_ReceivedCapabilities:
      max = freerdp_settings_get_uint32(settings, FreeRDP_ReceivedCapabilitiesSize);
      if (offset >= max)
        goto fail;
      return &settings->ReceivedCapabilities[offset];
    case FreeRDP_TargetNetAddresses:
      max = freerdp_settings_get_uint32(settings, FreeRDP_TargetNetAddressCount);
      if (offset >= max)
        goto fail;
      WINPR_ASSERT(settings->TargetNetAddresses);
      return settings->TargetNetAddresses[offset];
    case FreeRDP_TargetNetPorts:
      max = freerdp_settings_get_uint32(settings, FreeRDP_TargetNetAddressCount);
      if (offset >= max)
        goto fail;
      WINPR_ASSERT(settings->TargetNetPorts);
      return &settings->TargetNetPorts[offset];
    case FreeRDP_ClientTimeZone:
      max = 1;
      if (offset >= max)
        goto fail;
      return settings->ClientTimeZone;
    case FreeRDP_RdpServerCertificate:
      max = 1;
      if (offset >= max)
        goto fail;
      return settings->RdpServerCertificate;
    case FreeRDP_RdpServerRsaKey:
      max = 1;
      if (offset >= max)
        goto fail;
      return settings->RdpServerRsaKey;
    case FreeRDP_ServerLicenseProductIssuers:
      max = freerdp_settings_get_uint32(settings, FreeRDP_ServerLicenseProductIssuersCount);
      if (offset >= max)
        goto fail;
      return settings->ServerLicenseProductIssuers[offset];
    case FreeRDP_ReceivedCapabilityData:
      max = freerdp_settings_get_uint32(settings, FreeRDP_ReceivedCapabilitiesSize);
      if (offset >= max)
        goto fail;
      WINPR_ASSERT(settings->ReceivedCapabilityData);
      return settings->ReceivedCapabilityData[offset];
 
    case FreeRDP_ReceivedCapabilityDataSizes:
      max = freerdp_settings_get_uint32(settings, FreeRDP_ReceivedCapabilitiesSize);
      if (offset >= max)
        goto fail;
      WINPR_ASSERT(settings->ReceivedCapabilityDataSizes);
      return &settings->ReceivedCapabilityDataSizes[offset];
    default:
      WLog_WARN(TAG, "Invalid id %s [%d]", freerdp_settings_get_name_for_key(id), id);
      return NULL;
  }
 
fail:
  WLog_WARN(TAG, "Invalid offset for %s [%d]: size=%" PRIuz ", offset=%" PRIuz,
            freerdp_settings_get_name_for_key(id), id, max, offset);
  return NULL;
}

◆ freerdp_settings_get_pointer_writable()

WINPR_ATTR_NODISCARD 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 4088 of file settings_getters.c.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ freerdp_settings_get_server_name()

WINPR_ATTR_NODISCARD 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 2025 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()

WINPR_ATTR_NODISCARD 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

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

Here is the caller graph for this function:

◆ freerdp_settings_get_string_as_utf16()

WINPR_ATTR_NODISCARD 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 2297 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()

WINPR_ATTR_NODISCARD 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 3048 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_GatewayAvdAccessAadFormat:
      return settings->GatewayAvdAccessAadFormat;
 
    case FreeRDP_GatewayAvdAccessTokenFormat:
      return settings->GatewayAvdAccessTokenFormat;
 
    case FreeRDP_GatewayAvdActivityhint:
      return settings->GatewayAvdActivityhint;
 
    case FreeRDP_GatewayAvdArmpath:
      return settings->GatewayAvdArmpath;
 
    case FreeRDP_GatewayAvdClientID:
      return settings->GatewayAvdClientID;
 
    case FreeRDP_GatewayAvdDiagnosticserviceurl:
      return settings->GatewayAvdDiagnosticserviceurl;
 
    case FreeRDP_GatewayAvdGeo:
      return settings->GatewayAvdGeo;
 
    case FreeRDP_GatewayAvdHubdiscoverygeourl:
      return settings->GatewayAvdHubdiscoverygeourl;
 
    case FreeRDP_GatewayAvdScope:
      return settings->GatewayAvdScope;
 
    case FreeRDP_GatewayAvdWvdEndpointPool:
      return settings->GatewayAvdWvdEndpointPool;
 
    case FreeRDP_GatewayAzureActiveDirectory:
      return settings->GatewayAzureActiveDirectory;
 
    case FreeRDP_GatewayDomain:
      return settings->GatewayDomain;
 
    case FreeRDP_GatewayHostname:
      return settings->GatewayHostname;
 
    case FreeRDP_GatewayHttpExtAuthBearer:
      return settings->GatewayHttpExtAuthBearer;
 
    case FreeRDP_GatewayHttpMsUserAgent:
      return settings->GatewayHttpMsUserAgent;
 
    case FreeRDP_GatewayHttpReferer:
      return settings->GatewayHttpReferer;
 
    case FreeRDP_GatewayHttpUserAgent:
      return settings->GatewayHttpUserAgent;
 
    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 %d [%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()

WINPR_ATTR_NODISCARD 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 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->type;
  }
  return -1;
}

Referenced by freerdp_settings_copy_item(), freerdp_settings_deserialize(), freerdp_settings_get_type_name_for_key(), and freerdp_settings_serialize().

Here is the caller graph for this function:

◆ freerdp_settings_get_type_for_name()

WINPR_ATTR_NODISCARD 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 364 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()

WINPR_ATTR_NODISCARD 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 377 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().

Referenced by freerdp_settings_get_pointer_writable(), and freerdp_settings_get_string_writable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ freerdp_settings_get_type_name_for_type()

WINPR_ATTR_NODISCARD 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 383 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_deserialize(), freerdp_settings_get_type_name_for_key(), and freerdp_settings_serialize().

Here is the caller graph for this function:

◆ freerdp_settings_get_uint16()

WINPR_ATTR_NODISCARD 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

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

Here is the caller graph for this function:

◆ freerdp_settings_get_uint32()

WINPR_ATTR_NODISCARD 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

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

Here is the caller graph for this function:

◆ freerdp_settings_get_uint64()

WINPR_ATTR_NODISCARD 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

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

Here is the caller graph for this function:

◆ freerdp_settings_new()

WINPR_ATTR_NODISCARD 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 766 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 (!server && !remote)
  {
    if (!freerdp_settings_set_string(settings, FreeRDP_GatewayHttpUserAgent,
                                     FREERDP_USER_AGENT))
      goto out_fail;
    if (!freerdp_settings_set_string(settings, FreeRDP_GatewayHttpMsUserAgent,
                                     FREERDP_USER_AGENT))
      goto out_fail;
 
    if (!freerdp_settings_set_string(settings, FreeRDP_GatewayHttpReferer, ""))
      goto out_fail;
    if (!freerdp_settings_set_string(settings, FreeRDP_GatewayAvdAccessTokenFormat,
                                     "ms-appx-web%%3a%%2f%%2fMicrosoft.AAD.BrokerPlugin%%2f%s"))
      goto out_fail;
    if (!freerdp_settings_set_string(settings, FreeRDP_GatewayAvdAccessAadFormat,
                                     "https%%3A%%2F%%2F%s%%2F%s%%2Foauth2%%2Fnativeclient"))
      goto out_fail;
    if (!freerdp_settings_set_string(settings, FreeRDP_GatewayAvdScope,
                                     "https%3A%2F%2Fwww.wvd.microsoft.com%2F.default%20openid%"
                                     "20profile%20offline_access"))
 
      goto out_fail;
    if (!freerdp_settings_set_string(settings, FreeRDP_GatewayAvdClientID,
                                     "a85cf173-4192-42f8-81fa-777a763e6e2c"))
      goto out_fail;
    if (!freerdp_settings_set_string(settings, FreeRDP_GatewayAzureActiveDirectory,
                                     "login.microsoftonline.com"))
      goto out_fail;
    if (!freerdp_settings_set_string(settings, FreeRDP_GatewayAvdAadtenantid, "common"))
      goto out_fail;
    if (!freerdp_settings_set_bool(settings, FreeRDP_GatewayAvdUseTenantid, FALSE))
      goto out_fail;
    if (!freerdp_settings_set_uint32(settings, FreeRDP_DesktopPhysicalWidth, 1000))
      goto out_fail;
    if (!freerdp_settings_set_uint32(settings, FreeRDP_DesktopPhysicalHeight, 1000))
      goto out_fail;
    if (!freerdp_settings_set_uint16(settings, FreeRDP_DesktopOrientation,
                                     ORIENTATION_LANDSCAPE))
      goto out_fail;
    if (!freerdp_settings_set_uint32(settings, FreeRDP_DeviceScaleFactor, 100))
      goto out_fail;
    if (!freerdp_settings_set_uint32(settings, FreeRDP_DesktopScaleFactor, 100))
      goto out_fail;
  }
  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_RestrictedAdminModeSupported, TRUE) ||
      !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_int32(settings, FreeRDP_MonitorLocalShiftX, 0))
    goto out_fail;
 
  if (!freerdp_settings_set_int32(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_init_computer_name(settings))
    goto out_fail;
 
  if (!freerdp_settings_set_pointer_len(settings, FreeRDP_RdpServerCertificate, NULL, 1))
    goto out_fail;
 
  if (!freerdp_capability_buffer_resize(settings, 32, FALSE))
    goto out_fail;
 
  {
    char tmp[32] = { 0 };
    if (!freerdp_settings_set_string_len(settings, FreeRDP_ClientProductId, tmp, sizeof(tmp)))
      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;
      default:
        goto out_fail;
    }
 
    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) ||
      !freerdp_settings_set_bool(settings, FreeRDP_SupportDisplayControl, TRUE))
    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:
  WINPR_PRAGMA_DIAG_PUSH
  WINPR_PRAGMA_DIAG_IGNORED_MISMATCHED_DEALLOC
  freerdp_settings_free(settings);
  WINPR_PRAGMA_DIAG_POP
  return NULL;
}

References freerdp_settings_free(), freerdp_settings_get_bool(), freerdp_settings_get_config_path(), freerdp_settings_get_pointer_writable(), freerdp_settings_get_string(), FREERDP_SETTINGS_SERVER_MODE, freerdp_settings_set_bool(), freerdp_settings_set_int32(), freerdp_settings_set_pointer_len(), freerdp_settings_set_string(), freerdp_settings_set_string_from_utf16N(), freerdp_settings_set_string_len(), freerdp_settings_set_uint16(), and freerdp_settings_set_uint32().

Referenced by freerdp_settings_deserialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 99 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;
      default:
        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_serialize()

WINPR_ATTR_NODISCARD FREERDP_API char * freerdp_settings_serialize	(	const rdpSettings *	settings,
		BOOL	pretty,
		size_t *	plength
	)

A function that converts a rdpSettings struct to a JSON serialized string.

Parameters

settings	The settings instance to serialize
pretty	Format the resulting JSON human readable
plength	An optional pointer that receives the length (strlen) of the returned string.

Returns: A JSON string representing the serialized form of the rdpSettings or NULL in case of an error.

Since: version 3.16.0

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

{
  char* str = NULL;
 
  if (plength)
    *plength = 0;
 
  if (!settings)
    return NULL;
 
  WINPR_JSON* json = WINPR_JSON_CreateObject();
  if (!json)
    return NULL;
 
  WINPR_JSON* jbool = WINPR_JSON_AddObjectToObject(
      json, freerdp_settings_get_type_name_for_type(RDP_SETTINGS_TYPE_BOOL));
  WINPR_JSON* juint16 = WINPR_JSON_AddObjectToObject(
      json, freerdp_settings_get_type_name_for_type(RDP_SETTINGS_TYPE_UINT16));
  WINPR_JSON* jint16 = WINPR_JSON_AddObjectToObject(
      json, freerdp_settings_get_type_name_for_type(RDP_SETTINGS_TYPE_INT16));
  WINPR_JSON* juint32 = WINPR_JSON_AddObjectToObject(
      json, freerdp_settings_get_type_name_for_type(RDP_SETTINGS_TYPE_UINT32));
  WINPR_JSON* jint32 = WINPR_JSON_AddObjectToObject(
      json, freerdp_settings_get_type_name_for_type(RDP_SETTINGS_TYPE_INT32));
  WINPR_JSON* juint64 = WINPR_JSON_AddObjectToObject(
      json, freerdp_settings_get_type_name_for_type(RDP_SETTINGS_TYPE_UINT64));
  WINPR_JSON* jint64 = WINPR_JSON_AddObjectToObject(
      json, freerdp_settings_get_type_name_for_type(RDP_SETTINGS_TYPE_INT64));
  WINPR_JSON* jstring = WINPR_JSON_AddObjectToObject(
      json, freerdp_settings_get_type_name_for_type(RDP_SETTINGS_TYPE_STRING));
  WINPR_JSON* jpointer = WINPR_JSON_AddObjectToObject(
      json, freerdp_settings_get_type_name_for_type(RDP_SETTINGS_TYPE_POINTER));
  if (!jbool || !juint16 || !jint16 || !juint32 || !jint32 || !juint64 || !jint64 || !jstring ||
      !jpointer)
    goto fail;
 
  for (int x = 0; x < FreeRDP_Settings_StableAPI_MAX; x++)
  {
    union
    {
 
      int s;
      FreeRDP_Settings_Keys_Bool b;
      FreeRDP_Settings_Keys_Int16 i16;
      FreeRDP_Settings_Keys_UInt16 u16;
      FreeRDP_Settings_Keys_Int32 i32;
      FreeRDP_Settings_Keys_UInt32 u32;
      FreeRDP_Settings_Keys_Int64 i64;
      FreeRDP_Settings_Keys_UInt64 u64;
      FreeRDP_Settings_Keys_String str;
      FreeRDP_Settings_Keys_Pointer ptr;
    } iter;
    iter.s = x;
 
    const char* name = freerdp_settings_get_name_for_key(iter.s);
    SSIZE_T type = freerdp_settings_get_type_for_key(iter.s);
    switch (type)
    {
      case RDP_SETTINGS_TYPE_BOOL:
      {
        const BOOL val = freerdp_settings_get_bool(settings, iter.b);
        if (!WINPR_JSON_AddBoolToObject(jbool, name, val))
          goto fail;
      }
      break;
      case RDP_SETTINGS_TYPE_UINT16:
      {
        const uint16_t val = freerdp_settings_get_uint16(settings, iter.u16);
        if (!WINPR_JSON_AddNumberToObject(juint16, name, (double)val))
          goto fail;
      }
      break;
      case RDP_SETTINGS_TYPE_INT16:
      {
        const int16_t val = freerdp_settings_get_int16(settings, iter.i16);
        if (!WINPR_JSON_AddNumberToObject(jint16, name, (double)val))
          goto fail;
      }
      break;
      case RDP_SETTINGS_TYPE_UINT32:
      {
        const uint32_t val = freerdp_settings_get_uint32(settings, iter.u32);
        if (!WINPR_JSON_AddNumberToObject(juint32, name, (double)val))
          goto fail;
      }
      break;
      case RDP_SETTINGS_TYPE_INT32:
      {
        const int32_t val = freerdp_settings_get_int32(settings, iter.i32);
        if (!WINPR_JSON_AddNumberToObject(jint32, name, (double)val))
          goto fail;
      }
      break;
      case RDP_SETTINGS_TYPE_UINT64:
      {
        const uint64_t val = freerdp_settings_get_uint64(settings, iter.u64);
        if (!WINPR_JSON_AddNumberToObject(juint64, name, (double)val))
          goto fail;
      }
      break;
      case RDP_SETTINGS_TYPE_INT64:
      {
        const int64_t val = freerdp_settings_get_int64(settings, iter.i64);
        if (!WINPR_JSON_AddNumberToObject(jint64, name, (double)val))
          goto fail;
      }
      break;
      case RDP_SETTINGS_TYPE_STRING:
      {
        const char* val = freerdp_settings_get_string(settings, iter.str);
        if (val)
        {
          if (!WINPR_JSON_AddStringToObject(jstring, name, val))
            goto fail;
        }
        else
        {
          (void)WINPR_JSON_AddNullToObject(jstring, name);
        }
      }
      break;
      case RDP_SETTINGS_TYPE_POINTER:
        if (!serialize_pointer(settings, jpointer, iter.ptr))
          goto fail;
        break;
      default:
        break;
    }
  }
 
  if (pretty)
    str = WINPR_JSON_Print(json);
  else
    str = WINPR_JSON_PrintUnformatted(json);
 
  if (!str)
    goto fail;
  if (plength)
    *plength = strlen(str);
 
fail:
  WINPR_JSON_Delete(json);
  return str;
}

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

Referenced by freerdp_set_gateway_usage_method(), freerdp_settings_copy_item(), freerdp_settings_deserialize(), and freerdp_settings_new().

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

Referenced by freerdp_settings_copy_item(), and freerdp_settings_deserialize().

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

Referenced by freerdp_settings_copy_item(), freerdp_settings_deserialize(), freerdp_settings_new(), and freerdp_settings_set_monitor_def_array_sorted().

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

Referenced by freerdp_settings_copy_item(), and freerdp_settings_deserialize().

Here is the caller graph for this function:

◆ freerdp_settings_set_monitor_def_array_sorted()

WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_monitor_def_array_sorted	(	rdpSettings *	settings,
		const rdpMonitor *	monitors,
		size_t	count
	)

Sort monitor array according to:

First monitor is at x/y 0/0 and is the primary monitor
The primary monitor must be at 0/0, if not set FreeRDP_MonitorLocalShiftX/FreeRDP_MonitorLocalShiftY

The FreeRDP_MonitorLocalShiftX/FreeRDP_MonitorLocalShiftY is required to map the local monitors / mouse / touch coordinates to the remote ones.

Parameters

settings	The settings to set the monitors for
monitors	The unsorted monitors array
count	The number of monitors in the unsorted array

Returns: TRUE if the configuration is valid (or could be corrected to a valid one), FALSE otherwise.

Version: since 3.11.0

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

{
  WINPR_ASSERT(monitors || (count == 0));
  if (count == 0)
  {
    if (!freerdp_settings_set_int32(settings, FreeRDP_MonitorLocalShiftX, 0))
      return FALSE;
    if (!freerdp_settings_set_int32(settings, FreeRDP_MonitorLocalShiftY, 0))
      return FALSE;
    if (!freerdp_settings_set_pointer_len(settings, FreeRDP_MonitorDefArray, NULL, 0))
      return FALSE;
    return freerdp_settings_set_uint32(settings, FreeRDP_MonitorCount, 0);
  }
 
  // Find primary or alternatively the monitor at 0/0
  const rdpMonitor* primary = NULL;
  for (size_t x = 0; x < count; x++)
  {
    const rdpMonitor* cur = &monitors[x];
    if (cur->is_primary)
    {
      primary = cur;
      break;
    }
  }
  if (!primary)
  {
    for (size_t x = 0; x < count; x++)
    {
      const rdpMonitor* cur = &monitors[x];
      if ((cur->x == 0) && (cur->y == 0))
      {
        primary = cur;
        break;
      }
    }
  }
 
  if (!primary)
  {
    WLog_ERR(TAG, "Could not find primary monitor, aborting");
    return FALSE;
  }
 
  if (!freerdp_settings_set_pointer_len(settings, FreeRDP_MonitorDefArray, NULL, count))
    return FALSE;
  rdpMonitor* sorted = freerdp_settings_get_pointer_writable(settings, FreeRDP_MonitorDefArray);
  WINPR_ASSERT(sorted);
 
  size_t sortpos = 0;
 
  /* Set primary. Ensure left/top is at 0/0 and flags contains MONITOR_PRIMARY */
  sorted[sortpos] = *primary;
  sorted[sortpos].x = 0;
  sorted[sortpos].y = 0;
  sorted[sortpos].is_primary = TRUE;
  sortpos++;
 
  /* Set monitor shift to original layout */
  const INT32 offsetX = primary->x;
  const INT32 offsetY = primary->y;
  if (!freerdp_settings_set_int32(settings, FreeRDP_MonitorLocalShiftX, offsetX))
    return FALSE;
  if (!freerdp_settings_set_int32(settings, FreeRDP_MonitorLocalShiftY, offsetY))
    return FALSE;
 
  for (size_t x = 0; x < count; x++)
  {
    const rdpMonitor* cur = &monitors[x];
    if (cur == primary)
      continue;
 
    rdpMonitor m = monitors[x];
    m.x -= offsetX;
    m.y -= offsetY;
    sorted[sortpos++] = m;
  }
 
  // Sort remaining monitors by x/y ?
  qsort(sorted, count, sizeof(rdpMonitor), sort_monitor_fn);
 
  return freerdp_settings_set_uint32(settings, FreeRDP_MonitorCount,
                                     WINPR_ASSERTING_INT_CAST(uint32_t, count));
}

References freerdp_settings_get_pointer_writable(), freerdp_settings_set_int32(), freerdp_settings_set_pointer_len(), and freerdp_settings_set_uint32().

Here is the call 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

Referenced by freerdp_settings_copy_item(), and freerdp_settings_set_pointer_len().

Here is the caller graph for this function:

◆ freerdp_settings_set_pointer_array()

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

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

{
  size_t maxOffset = 0;
  if (!settings)
    return FALSE;
  switch (id)
  {
    case FreeRDP_ClientAutoReconnectCookie:
      maxOffset = 1;
      if ((offset >= maxOffset) || !data || !settings->ClientAutoReconnectCookie)
        goto fail;
      settings->ClientAutoReconnectCookie[offset] = *(const ARC_CS_PRIVATE_PACKET*)data;
      return TRUE;
    case FreeRDP_ServerAutoReconnectCookie:
      maxOffset = 1;
      if ((offset >= maxOffset) || !data || !settings->ServerAutoReconnectCookie)
        goto fail;
      settings->ServerAutoReconnectCookie[offset] = *(const ARC_SC_PRIVATE_PACKET*)data;
      return TRUE;
    case FreeRDP_ServerCertificate:
      maxOffset = freerdp_settings_get_uint32(settings, FreeRDP_ServerCertificateLength);
      if ((offset >= maxOffset) || !data)
        goto fail;
      settings->ServerCertificate[offset] = *(const BYTE*)data;
      return TRUE;
    case FreeRDP_DeviceArray:
      maxOffset = freerdp_settings_get_uint32(settings, FreeRDP_DeviceArraySize);
      if (offset >= maxOffset)
        goto fail;
      freerdp_device_free(settings->DeviceArray[offset]);
      settings->DeviceArray[offset] = freerdp_device_clone(data);
      return TRUE;
    case FreeRDP_TargetNetAddresses:
      maxOffset = freerdp_settings_get_uint32(settings, FreeRDP_TargetNetAddressCount);
      if ((offset >= maxOffset) || !data)
        goto fail;
      WINPR_ASSERT(settings->TargetNetAddresses);
      free(settings->TargetNetAddresses[offset]);
      settings->TargetNetAddresses[offset] = _strdup((const char*)data);
      return settings->TargetNetAddresses[offset] != NULL;
    case FreeRDP_TargetNetPorts:
      maxOffset = freerdp_settings_get_uint32(settings, FreeRDP_TargetNetAddressCount);
      if ((offset >= maxOffset) || !data)
        goto fail;
      WINPR_ASSERT(settings->TargetNetPorts);
      settings->TargetNetPorts[offset] = *((const UINT32*)data);
      return TRUE;
    case FreeRDP_StaticChannelArray:
      maxOffset = freerdp_settings_get_uint32(settings, FreeRDP_StaticChannelArraySize);
      if ((offset >= maxOffset) || !data)
        goto fail;
      freerdp_addin_argv_free(settings->StaticChannelArray[offset]);
      settings->StaticChannelArray[offset] = freerdp_addin_argv_clone(data);
      return TRUE;
    case FreeRDP_DynamicChannelArray:
      maxOffset = freerdp_settings_get_uint32(settings, FreeRDP_DynamicChannelArraySize);
      if ((offset >= maxOffset) || !data)
        goto fail;
      freerdp_addin_argv_free(settings->DynamicChannelArray[offset]);
      settings->DynamicChannelArray[offset] = freerdp_addin_argv_clone(data);
      return TRUE;
    case FreeRDP_BitmapCacheV2CellInfo:
      maxOffset = freerdp_settings_get_uint32(settings, FreeRDP_BitmapCacheV2NumCells);
      if ((offset >= maxOffset) || !data)
        goto fail;
      {
        const BITMAP_CACHE_V2_CELL_INFO* cdata = (const BITMAP_CACHE_V2_CELL_INFO*)data;
        settings->BitmapCacheV2CellInfo[offset] = *cdata;
      }
      return TRUE;
    case FreeRDP_ServerRandom:
      maxOffset = freerdp_settings_get_uint32(settings, FreeRDP_ServerRandomLength);
      if ((offset >= maxOffset) || !data)
        goto fail;
      settings->ServerRandom[offset] = *(const BYTE*)data;
      return TRUE;
    case FreeRDP_ClientRandom:
      maxOffset = freerdp_settings_get_uint32(settings, FreeRDP_ClientRandomLength);
      if ((offset >= maxOffset) || !data)
        goto fail;
      settings->ClientRandom[offset] = *(const BYTE*)data;
      return TRUE;
    case FreeRDP_LoadBalanceInfo:
      maxOffset = freerdp_settings_get_uint32(settings, FreeRDP_LoadBalanceInfoLength);
      if ((offset >= maxOffset) || !data)
        goto fail;
      settings->LoadBalanceInfo[offset] = *(const BYTE*)data;
      return TRUE;
    case FreeRDP_RedirectionTsvUrl:
      maxOffset = freerdp_settings_get_uint32(settings, FreeRDP_RedirectionTsvUrlLength);
      if ((offset >= maxOffset) || !data)
        goto fail;
      settings->RedirectionTsvUrl[offset] = *(const BYTE*)data;
      return TRUE;
    case FreeRDP_RedirectionPassword:
      maxOffset = freerdp_settings_get_uint32(settings, FreeRDP_RedirectionPasswordLength);
      if ((offset >= maxOffset) || !data)
        goto fail;
      settings->RedirectionPassword[offset] = *(const BYTE*)data;
      return TRUE;
    case FreeRDP_OrderSupport:
      maxOffset = 32;
      if (!settings->OrderSupport)
        goto fail;
      if ((offset >= maxOffset) || !data)
        goto fail;
      settings->OrderSupport[offset] = *(const BOOL*)data ? 1 : 0;
      return TRUE;
    case FreeRDP_GlyphCache:
      maxOffset = 10;
      if (!settings->GlyphCache)
        goto fail;
      if ((offset >= maxOffset) || !data)
        goto fail;
      settings->GlyphCache[offset] = *(const GLYPH_CACHE_DEFINITION*)data;
      return TRUE;
    case FreeRDP_FragCache:
      maxOffset = 1;
      if (!settings->FragCache)
        goto fail;
      if ((offset >= maxOffset) || !data)
        goto fail;
      settings->FragCache[offset] = *(const GLYPH_CACHE_DEFINITION*)data;
      return TRUE;
    case FreeRDP_MonitorIds:
      maxOffset = freerdp_settings_get_uint32(settings, FreeRDP_NumMonitorIds);
      if ((offset >= maxOffset) || !data)
        goto fail;
      settings->MonitorIds[offset] = *(const UINT32*)data;
      return TRUE;
    case FreeRDP_ChannelDefArray:
      maxOffset = freerdp_settings_get_uint32(settings, FreeRDP_ChannelDefArraySize);
      if ((offset >= maxOffset) || !data)
        goto fail;
      settings->ChannelDefArray[offset] = *(const CHANNEL_DEF*)data;
      return TRUE;
    case FreeRDP_MonitorDefArray:
      maxOffset = freerdp_settings_get_uint32(settings, FreeRDP_MonitorDefArraySize);
      if ((offset >= maxOffset) || !data)
        goto fail;
      settings->MonitorDefArray[offset] = *(const rdpMonitor*)data;
      return TRUE;
 
    case FreeRDP_ClientTimeZone:
      maxOffset = 1;
      if ((offset >= maxOffset) || !data || !settings->ClientTimeZone)
        goto fail;
      settings->ClientTimeZone[offset] = *(const TIME_ZONE_INFORMATION*)data;
      return TRUE;
 
    case FreeRDP_ServerLicenseProductIssuers:
      maxOffset =
          freerdp_settings_get_uint32(settings, FreeRDP_ServerLicenseProductIssuersCount);
      if ((offset >= maxOffset) || !settings->ServerLicenseProductIssuers)
        goto fail;
      free(settings->ServerLicenseProductIssuers[offset]);
      settings->ServerLicenseProductIssuers[offset] = NULL;
      if (data)
        settings->ServerLicenseProductIssuers[offset] = _strdup((const char*)data);
      return TRUE;
 
    case FreeRDP_ReceivedCapabilityData:
      maxOffset = freerdp_settings_get_uint32(settings, FreeRDP_ReceivedCapabilitiesSize);
      if (offset >= maxOffset)
        goto fail;
      WINPR_ASSERT(settings->ReceivedCapabilityData);
      settings->ReceivedCapabilityData[offset] = WINPR_CAST_CONST_PTR_AWAY(data, BYTE*);
      return TRUE;
    case FreeRDP_ReceivedCapabilityDataSizes:
      maxOffset = freerdp_settings_get_uint32(settings, FreeRDP_ReceivedCapabilitiesSize);
      if (offset >= maxOffset)
        goto fail;
      WINPR_ASSERT(settings->ReceivedCapabilityDataSizes);
      settings->ReceivedCapabilityDataSizes[offset] = *(const uint32_t*)data;
      return TRUE;
    default:
      WLog_WARN(TAG, "Invalid id %s [%d]", freerdp_settings_get_name_for_key(id), id);
      return FALSE;
  }
 
fail:
  WLog_WARN(TAG, "[%s] Invalid offset=%" PRIuz " [%" PRIuz "] or NULL data=%p",
            freerdp_settings_get_name_for_key(id), offset, maxOffset, data);
  return FALSE;
}

◆ 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 1442 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 (!freerdp_target_net_addresses_resize(settings, len))
        return FALSE;
      if (data == NULL)
        target_net_addresses_free(settings, 0);
      return TRUE;
    case FreeRDP_ServerLicenseProductIssuers:
      if (data == NULL)
        freerdp_server_license_issuers_free(settings);
      return freerdp_settings_set_pointer_len_(
          settings, id, FreeRDP_ServerLicenseProductIssuersCount, data, len, sizeof(char*));
    case FreeRDP_TargetNetPorts:
      if (!freerdp_target_net_addresses_resize(settings, len))
        return FALSE;
      if (data == NULL)
      {
        for (size_t x = 0; x < len; x++)
          settings->TargetNetPorts[x] = 0;
      }
      return TRUE;
    case FreeRDP_DeviceArray:
      if (data == NULL)
        freerdp_device_collection_free(settings);
      return freerdp_settings_set_pointer_len_(settings, id, FreeRDP_DeviceArraySize, data,
                                               len, sizeof(RDPDR_DEVICE*));
    case FreeRDP_ChannelDefArray:
      if ((len > 0) && (len < CHANNEL_MAX_COUNT))
        WLog_WARN(TAG,
                  "FreeRDP_ChannelDefArray::len expected to be >= %d, but have %" PRIuz,
                  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, FreeRDP_UINT32_UNUSED, data, len,
                                               sizeof(ARC_CS_PRIVATE_PACKET));
    case FreeRDP_ServerAutoReconnectCookie:
      return freerdp_settings_set_pointer_len_(settings, id, FreeRDP_UINT32_UNUSED, 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, FreeRDP_UINT32_UNUSED, 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, FreeRDP_UINT32_UNUSED, 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, FreeRDP_UINT32_UNUSED, 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 (!freerdp_capability_buffer_resize(settings, len, FALSE))
        return FALSE;
      if (data == NULL)
      {
        freerdp_capability_data_free(settings, 0, FALSE);
      }
      return TRUE;
    case FreeRDP_ReceivedCapabilities:
      if (!freerdp_capability_buffer_resize(settings, len, FALSE))
        return FALSE;
      if (data == NULL)
      {
        for (size_t x = 0; x < settings->ReceivedCapabilitiesSize; x++)
        {
          settings->ReceivedCapabilities[x] = 0;
        }
      }
      return TRUE;
    case FreeRDP_OrderSupport:
      return freerdp_settings_set_pointer_len_(settings, id, FreeRDP_UINT32_UNUSED, data, len,
                                               sizeof(char));
 
    case FreeRDP_MonitorIds:
      return freerdp_settings_set_pointer_len_(settings, id, FreeRDP_NumMonitorIds, data, len,
                                               sizeof(UINT32));
 
    case FreeRDP_ReceivedCapabilityDataSizes:
      if (!freerdp_capability_buffer_resize(settings, len, FALSE))
        return FALSE;
      if (data == NULL)
      {
        for (size_t x = 0; x < settings->ReceivedCapabilitiesSize; x++)
          settings->ReceivedCapabilityDataSizes[x] = 0;
      }
      return TRUE;
 
    case FreeRDP_Password51:
      return freerdp_settings_set_pointer_len_(settings, id, FreeRDP_Password51Length, data,
                                               len, sizeof(char));
    default:
      if ((data == NULL) && (len == 0))
      {
        freerdp_settings_set_pointer(settings, id, NULL);
      }
      else
        WLog_WARN(TAG, "Invalid id %d", id);
      return FALSE;
  }
}

References freerdp_settings_set_pointer().

Referenced by freerdp_settings_new(), and freerdp_settings_set_monitor_def_array_sorted().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 3729 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(), freerdp_settings_deserialize(), and freerdp_settings_new().

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 2257 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 2274 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);
}

Referenced by freerdp_settings_new().

Here is the caller graph for this function:

◆ 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 3723 of file settings_getters.c.

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

Referenced by freerdp_settings_append_string(), and freerdp_settings_new().

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

Referenced by freerdp_settings_copy_item(), freerdp_settings_deserialize(), and freerdp_settings_new().

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

Referenced by freerdp_set_gateway_usage_method(), freerdp_settings_copy_item(), freerdp_settings_deserialize(), freerdp_settings_new(), and freerdp_settings_set_monitor_def_array_sorted().

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

Referenced by freerdp_settings_copy_item(), and freerdp_settings_deserialize().

Here is the caller graph for this function:

◆ freerdp_settings_set_value_for_name()

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

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

{
  ULONGLONG uval = 0;
  LONGLONG ival = 0;
  SSIZE_T type = 0;
 
  if (!settings || !name)
    return FALSE;
 
  const SSIZE_T i = freerdp_settings_get_key_for_name(name);
  if (i < 0)
  {
    WLog_ERR(TAG, "Invalid settings key [%s]", name);
    return FALSE;
  }
 
  const SSIZE_T index = i;
 
  type = freerdp_settings_get_type_for_key(index);
  switch (type)
  {
 
    case RDP_SETTINGS_TYPE_BOOL:
    {
      const BOOL val = (_strnicmp(value, "TRUE", 5) == 0) || (_strnicmp(value, "ON", 5) == 0);
      const BOOL nval =
          (_strnicmp(value, "FALSE", 6) == 0) || (_strnicmp(value, "OFF", 6) == 0);
      if (!val && !nval)
        return parsing_fail(name, "BOOL", value);
 
      // NOLINTNEXTLINE(clang-analyzer-optin.core.EnumCastOutOfRange)
      return freerdp_settings_set_bool(settings, (FreeRDP_Settings_Keys_Bool)index, val);
    }
    case RDP_SETTINGS_TYPE_UINT16:
      if (!value_to_uint(value, &uval, 0, UINT16_MAX))
        return parsing_fail(name, "UINT16", value);
 
      // NOLINTNEXTLINE(clang-analyzer-optin.core.EnumCastOutOfRange)
      if (!freerdp_settings_set_uint16(settings, (FreeRDP_Settings_Keys_UInt16)index,
                                       (UINT16)uval))
        return parsing_fail(name, "UINT16", value);
      return TRUE;
 
    case RDP_SETTINGS_TYPE_INT16:
      if (!value_to_int(value, &ival, INT16_MIN, INT16_MAX))
        return parsing_fail(name, "INT16", value);
 
      // NOLINTNEXTLINE(clang-analyzer-optin.core.EnumCastOutOfRange)
      if (!freerdp_settings_set_int16(settings, (FreeRDP_Settings_Keys_Int16)index,
                                      (INT16)ival))
        return parsing_fail(name, "INT16", value);
      return TRUE;
    case RDP_SETTINGS_TYPE_UINT32:
      if (!value_to_uint(value, &uval, 0, UINT32_MAX))
        return parsing_fail(name, "UINT32", value);
 
      // NOLINTNEXTLINE(clang-analyzer-optin.core.EnumCastOutOfRange)
      if (!freerdp_settings_set_uint32(settings, (FreeRDP_Settings_Keys_UInt32)index,
                                       (UINT32)uval))
        return parsing_fail(name, "UINT32", value);
      return TRUE;
    case RDP_SETTINGS_TYPE_INT32:
      if (!value_to_int(value, &ival, INT32_MIN, INT32_MAX))
        return parsing_fail(name, "INT32", value);
 
      // NOLINTNEXTLINE(clang-analyzer-optin.core.EnumCastOutOfRange)
      if (!freerdp_settings_set_int32(settings, (FreeRDP_Settings_Keys_Int32)index,
                                      (INT32)ival))
        return parsing_fail(name, "INT32", value);
      return TRUE;
    case RDP_SETTINGS_TYPE_UINT64:
      if (!value_to_uint(value, &uval, 0, UINT64_MAX))
        return parsing_fail(name, "UINT64", value);
 
      // NOLINTNEXTLINE(clang-analyzer-optin.core.EnumCastOutOfRange)
      if (!freerdp_settings_set_uint64(settings, (FreeRDP_Settings_Keys_UInt64)index, uval))
        return parsing_fail(name, "UINT64", value);
      return TRUE;
    case RDP_SETTINGS_TYPE_INT64:
      if (!value_to_int(value, &ival, INT64_MIN, INT64_MAX))
        return parsing_fail(name, "INT64", value);
 
      // NOLINTNEXTLINE(clang-analyzer-optin.core.EnumCastOutOfRange)
      if (!freerdp_settings_set_int64(settings, (FreeRDP_Settings_Keys_Int64)index, ival))
        return parsing_fail(name, "INT64", value);
      return TRUE;
 
    case RDP_SETTINGS_TYPE_STRING:
      // NOLINTNEXTLINE(clang-analyzer-optin.core.EnumCastOutOfRange)
      return freerdp_settings_set_string(settings, (FreeRDP_Settings_Keys_String)index,
                                         value);
    case RDP_SETTINGS_TYPE_POINTER:
      return parsing_fail(name, "POINTER", value);
    default:
      return FALSE;
  }
  return FALSE;
}

◆ freerdp_settings_update_from_caps()

WINPR_ATTR_NODISCARD 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 capability 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 2191 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);
 
  wLog* log = WLog_Get(TAG);
 
  for (UINT32 x = 0; x < capsCount; x++)
  {
    if (capsFlags[x])
    {
      wStream buffer = { 0 };
      wStream* sub = Stream_StaticConstInit(&buffer, capsData[x], capsSizes[x]);
 
      if (!rdp_read_capability_set(log, sub, (UINT16)x, settings, serverReceivedCaps))
        return FALSE;
    }
  }
 
  return TRUE;
}

◆ freerdp_static_channel_collection_add()

FREERDP_API BOOL freerdp_static_channel_collection_add	(	rdpSettings *	settings,
		ADDIN_ARGV *	channel
	)

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

{
  UINT32 count = 0;
 
  WINPR_ASSERT(settings);
  WINPR_ASSERT(channel);
 
  count = freerdp_settings_get_uint32(settings, FreeRDP_StaticChannelCount) + 1;
  if (freerdp_settings_get_uint32(settings, FreeRDP_StaticChannelArraySize) < count)
  {
    const UINT32 oldSize =
        freerdp_settings_get_uint32(settings, FreeRDP_StaticChannelArraySize);
    const size_t new_size = oldSize + 32ul;
    ADDIN_ARGV** new_array = (ADDIN_ARGV**)realloc((void*)settings->StaticChannelArray,
                                                   new_size * sizeof(ADDIN_ARGV*));
 
    if (!new_array)
      return FALSE;
 
    settings->StaticChannelArray = new_array;
    {
      for (size_t x = oldSize; x < new_size; x++)
        settings->StaticChannelArray[x] = NULL;
    }
    if (!freerdp_settings_set_uint32(settings, FreeRDP_StaticChannelArraySize,
                                     WINPR_ASSERTING_INT_CAST(uint32_t, new_size)))
      return FALSE;
  }
 
  count = freerdp_settings_get_uint32(settings, FreeRDP_StaticChannelCount);
 
  ADDIN_ARGV** cur = &settings->StaticChannelArray[count++];
  freerdp_addin_argv_free(*cur);
  *cur = channel;
  return freerdp_settings_set_uint32(settings, FreeRDP_StaticChannelCount, count);
}

◆ freerdp_static_channel_collection_del()

FREERDP_API BOOL freerdp_static_channel_collection_del	(	rdpSettings *	settings,
		const char *	name
	)

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

{
  const UINT32 count = freerdp_settings_get_uint32(settings, FreeRDP_StaticChannelCount);
  if (!settings || !settings->StaticChannelArray)
    return FALSE;
 
  for (UINT32 x = 0; x < count; x++)
  {
    ADDIN_ARGV* cur = settings->StaticChannelArray[x];
    if (cur && (cur->argc > 0))
    {
      if (strcmp(name, cur->argv[0]) == 0)
      {
        memmove_s((void*)&settings->StaticChannelArray[x],
                  (count - x) * sizeof(ADDIN_ARGV*),
                  (void*)&settings->StaticChannelArray[x + 1],
                  (count - x - 1) * sizeof(ADDIN_ARGV*));
        for (size_t y = count - 1; y < settings->StaticChannelArraySize; y++)
          settings->StaticChannelArray[y] = NULL;
 
        freerdp_addin_argv_free(cur);
        return freerdp_settings_set_uint32(settings, FreeRDP_StaticChannelCount, count - 1);
      }
    }
  }
  {
    for (size_t x = count; x < settings->StaticChannelArraySize; x++)
      settings->StaticChannelArray[x] = NULL;
  }
  return FALSE;
}

◆ freerdp_static_channel_collection_find()

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

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

{
  ADDIN_ARGV* channel = NULL;
 
  WINPR_ASSERT(settings);
  WINPR_ASSERT(name);
 
  for (UINT32 index = 0;
       index < freerdp_settings_get_uint32(settings, FreeRDP_StaticChannelCount); index++)
  {
    channel = settings->StaticChannelArray[index];
 
    if (strcmp(channel->argv[0], name) == 0)
      return channel;
  }
 
  return NULL;
}

◆ freerdp_static_channel_collection_free()

FREERDP_API void freerdp_static_channel_collection_free ( rdpSettings * settings )

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

{
  if (!settings)
    return;
 
  if (settings->StaticChannelArray)
  {
    for (UINT32 i = 0;
         i < freerdp_settings_get_uint32(settings, FreeRDP_StaticChannelArraySize); i++)
      freerdp_addin_argv_free(settings->StaticChannelArray[i]);
  }
 
  free((void*)settings->StaticChannelArray);
  (void)freerdp_settings_set_uint32(settings, FreeRDP_StaticChannelArraySize, 0);
  settings->StaticChannelArray = NULL;
  (void)freerdp_settings_set_uint32(settings, FreeRDP_StaticChannelCount, 0);
}

◆ freerdp_supported_color_depths_string()

WINPR_ATTR_NODISCARD 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

Parameters

mask	A bitmask of supported color dephts RNS_UD_*
buffer	A pointer to a buffer of size bytes
size	The size of the buffer in bytes

Returns: A string reprenentation of the bitmask.

Definition at line 2374 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;
}

◆ freerdp_target_net_addresses_copy()

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

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

{
  WINPR_ASSERT(settings);
  WINPR_ASSERT(addresses);
 
  if (!freerdp_target_net_adresses_reset(settings, count))
    return FALSE;
 
  for (UINT32 i = 0; i < settings->TargetNetAddressCount; i++)
  {
    const char* address = addresses[i];
    if (!freerdp_settings_set_pointer_array(settings, FreeRDP_TargetNetAddresses, i, address))
    {
      freerdp_target_net_addresses_free(settings);
      return FALSE;
    }
  }
 
  return TRUE;
}

◆ freerdp_target_net_addresses_free()

FREERDP_API void freerdp_target_net_addresses_free ( rdpSettings * settings )

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

{
  WINPR_ASSERT(settings);
 
  target_net_addresses_free(settings, 0);
 
  free((void*)settings->TargetNetAddresses);
  settings->TargetNetAddresses = NULL;
 
  free(settings->TargetNetPorts);
  settings->TargetNetPorts = NULL;
 
  settings->TargetNetAddressCount = 0;
}

◆ freerdp_update_gateway_usage_method()

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

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

{
  UINT32 GatewayUsageMethod = 0;
 
  if (!GatewayEnabled && !GatewayBypassLocal)
    GatewayUsageMethod = TSC_PROXY_MODE_NONE_DIRECT;
  else if (GatewayEnabled && !GatewayBypassLocal)
    GatewayUsageMethod = TSC_PROXY_MODE_DIRECT;
  else if (GatewayEnabled && GatewayBypassLocal)
    GatewayUsageMethod = TSC_PROXY_MODE_DETECT;
 
  freerdp_set_gateway_usage_method(settings, GatewayUsageMethod);
}

Data Structures

Macros

Enumerations

Functions

to value \b value

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

◆ AUDIO_MODE_NONE

◆ AUDIO_MODE_PLAY_ON_SERVER

◆ AUDIO_MODE_REDIRECT

◆ AUTO_RECONNECT_VERSION_1

◆ CHANNEL_OPTION_COMPRESS

◆ CHANNEL_OPTION_COMPRESS_RDP

◆ CHANNEL_OPTION_ENCRYPT_CS

◆ CHANNEL_OPTION_ENCRYPT_RDP

◆ CHANNEL_OPTION_ENCRYPT_SC

◆ CHANNEL_OPTION_INITIALIZED

◆ CHANNEL_OPTION_PRI_HIGH

◆ CHANNEL_OPTION_PRI_LOW

◆ CHANNEL_OPTION_PRI_MED

◆ CHANNEL_OPTION_SHOW_PROTOCOL

◆ CHANNEL_REMOTE_CONTROL_PERSISTENT

◆ CLIPRDR_FLAG_DEFAULT_MASK

◆ CLIPRDR_FLAG_LOCAL_TO_REMOTE

◆ CLIPRDR_FLAG_LOCAL_TO_REMOTE_FILES

◆ CLIPRDR_FLAG_REMOTE_TO_LOCAL

◆ CLIPRDR_FLAG_REMOTE_TO_LOCAL_FILES

◆ CONNECTION_TYPE_AUTODETECT

◆ CONNECTION_TYPE_BROADBAND_HIGH

◆ CONNECTION_TYPE_BROADBAND_LOW

◆ CONNECTION_TYPE_INVALID

◆ CONNECTION_TYPE_LAN

◆ CONNECTION_TYPE_MODEM

◆ CONNECTION_TYPE_SATELLITE

◆ CONNECTION_TYPE_WAN

◆ CS_CLUSTER

◆ CS_CORE

◆ CS_MCS_MSGCHANNEL

◆ CS_MONITOR

◆ CS_MONITOR_EX

◆ CS_MULTITRANSPORT

◆ CS_NET

◆ CS_SECURITY

◆ CS_UNUSED1

◆ DEFAULT_COOKIE_MAX_LENGTH

◆ ENCRYPTION_LEVEL_CLIENT_COMPATIBLE

◆ ENCRYPTION_LEVEL_FIPS

◆ ENCRYPTION_LEVEL_HIGH

◆ ENCRYPTION_LEVEL_LOW

◆ ENCRYPTION_LEVEL_NONE

◆ ENCRYPTION_METHOD_128BIT

◆ ENCRYPTION_METHOD_40BIT

◆ ENCRYPTION_METHOD_56BIT

◆ ENCRYPTION_METHOD_FIPS

◆ ENCRYPTION_METHOD_NONE

◆ FREERDP_MONITOR_OVERRIDE_DESKTOP_SCALE

◆ FREERDP_MONITOR_OVERRIDE_DEVICE_SCALE

◆ FREERDP_MONITOR_OVERRIDE_ORIENTATION

◆ FREERDP_SETTINGS_REMOTE_MODE

◆ FREERDP_SETTINGS_SERVER_MODE [1/2]

◆ FREERDP_SETTINGS_SERVER_MODE [2/2]

◆ GLYPH_SUPPORT_ENCODE