FreeRDP
Loading...
Searching...
No Matches
include/freerdp/settings.h
1
24#ifndef FREERDP_SETTINGS_H
25#define FREERDP_SETTINGS_H
26
27#include <winpr/timezone.h>
28#include <winpr/wlog.h>
29
30#include <freerdp/api.h>
31#include <freerdp/config.h>
32#include <freerdp/types.h>
33#include <freerdp/redirection.h>
34
35#if !defined(WITH_OPAQUE_SETTINGS)
36#include <freerdp/settings_types_private.h>
37#endif
38
39#include <freerdp/settings_keys.h>
40#include <freerdp/settings_types.h>
41
42#include <freerdp/crypto/certificate.h>
43#include <freerdp/crypto/privatekey.h>
44
45#ifdef __cplusplus
46extern "C"
47{
48#endif
49
75 typedef struct rdp_settings rdpSettings;
76
80#define FREERDP_SETTINGS_SERVER_MODE 0x00000001
81#define FREERDP_SETTINGS_REMOTE_MODE 0x00000002
82
87 FREERDP_API void freerdp_settings_free(rdpSettings* settings);
88
96 WINPR_ATTR_MALLOC(freerdp_settings_free, 1)
97 WINPR_ATTR_NODISCARD
98 FREERDP_API rdpSettings* freerdp_settings_new(DWORD flags);
99
106 WINPR_ATTR_MALLOC(freerdp_settings_free, 1)
107 WINPR_ATTR_NODISCARD
108 FREERDP_API rdpSettings* freerdp_settings_clone(const rdpSettings* settings);
109
119 WINPR_ATTR_NODISCARD
120 FREERDP_API BOOL freerdp_settings_copy(rdpSettings* dst, const rdpSettings* src);
121
132 WINPR_ATTR_NODISCARD
133 FREERDP_API BOOL freerdp_settings_copy_item(rdpSettings* dst, const rdpSettings* src,
134 SSIZE_T id);
135
142 FREERDP_API void freerdp_settings_dump(wLog* log, DWORD level, const rdpSettings* settings);
143
153 WINPR_ATTR_NODISCARD
154 FREERDP_API BOOL freerdp_settings_print_diff(wLog* log, DWORD level,
155 const rdpSettings* settings,
156 const rdpSettings* other);
157
158 FREERDP_API void freerdp_addin_argv_free(ADDIN_ARGV* args);
159
160 WINPR_ATTR_MALLOC(freerdp_addin_argv_free, 1)
161 WINPR_ATTR_NODISCARD
162 FREERDP_API ADDIN_ARGV* freerdp_addin_argv_new(size_t argc, const char* const argv[]);
163
164 WINPR_ATTR_MALLOC(freerdp_addin_argv_free, 1)
165 WINPR_ATTR_NODISCARD
166 FREERDP_API ADDIN_ARGV* freerdp_addin_argv_clone(const ADDIN_ARGV* args);
167
168 WINPR_ATTR_NODISCARD
169 FREERDP_API BOOL freerdp_addin_argv_add_argument(ADDIN_ARGV* args, const char* argument);
170
171 WINPR_ATTR_NODISCARD
172 FREERDP_API BOOL freerdp_addin_argv_add_argument_ex(ADDIN_ARGV* args, const char* argument,
173 size_t len);
174
175 WINPR_ATTR_NODISCARD
176 FREERDP_API BOOL freerdp_addin_argv_del_argument(ADDIN_ARGV* args, const char* argument);
177
178 WINPR_ATTR_NODISCARD
179 FREERDP_API int freerdp_addin_set_argument(ADDIN_ARGV* args, const char* argument);
180
181 WINPR_ATTR_NODISCARD
182 FREERDP_API int freerdp_addin_replace_argument(ADDIN_ARGV* args, const char* previous,
183 const char* argument);
184
185 WINPR_ATTR_NODISCARD
186 FREERDP_API int freerdp_addin_set_argument_value(ADDIN_ARGV* args, const char* option,
187 const char* value);
188
189 WINPR_ATTR_NODISCARD
190 FREERDP_API int freerdp_addin_replace_argument_value(ADDIN_ARGV* args, const char* previous,
191 const char* option, const char* value);
192
193 WINPR_ATTR_NODISCARD
194 FREERDP_API BOOL freerdp_device_collection_add(rdpSettings* settings, RDPDR_DEVICE* device);
195
206 WINPR_ATTR_NODISCARD
207 FREERDP_API BOOL freerdp_device_collection_del(rdpSettings* settings,
208 const RDPDR_DEVICE* device);
209 WINPR_ATTR_NODISCARD
210 FREERDP_API RDPDR_DEVICE* freerdp_device_collection_find(rdpSettings* settings,
211 const char* name);
212 WINPR_ATTR_NODISCARD
213 FREERDP_API RDPDR_DEVICE* freerdp_device_collection_find_type(rdpSettings* settings,
214 UINT32 type);
215
216 FREERDP_API void freerdp_device_free(RDPDR_DEVICE* device);
217
218 WINPR_ATTR_MALLOC(freerdp_device_free, 1)
219 WINPR_ATTR_NODISCARD
220 FREERDP_API RDPDR_DEVICE* freerdp_device_new(UINT32 Type, size_t count,
221 const char* const args[]);
222
223 WINPR_ATTR_MALLOC(freerdp_device_free, 1)
224 WINPR_ATTR_NODISCARD
225 FREERDP_API RDPDR_DEVICE* freerdp_device_clone(const RDPDR_DEVICE* device);
226
227 WINPR_ATTR_NODISCARD
228 FREERDP_API BOOL freerdp_device_equal(const RDPDR_DEVICE* what, const RDPDR_DEVICE* other);
229
230 FREERDP_API void freerdp_device_collection_free(rdpSettings* settings);
231
232 WINPR_ATTR_NODISCARD
233 FREERDP_API BOOL freerdp_static_channel_collection_add(rdpSettings* settings,
234 ADDIN_ARGV* channel);
235
236 FREERDP_API BOOL freerdp_static_channel_collection_del(rdpSettings* settings, const char* name);
237
238 WINPR_ATTR_NODISCARD
239 FREERDP_API ADDIN_ARGV* freerdp_static_channel_collection_find(rdpSettings* settings,
240 const char* name);
241#if defined(WITH_FREERDP_DEPRECATED)
242 WINPR_DEPRECATED(
243 WINPR_ATTR_NODISCARD FREERDP_API ADDIN_ARGV* WINPR_ATTR_MALLOC(freerdp_addin_argv_free, 1)
244 WINPR_ATTR_NODISCARD freerdp_static_channel_clone(ADDIN_ARGV* channel));
245#endif
246
247 FREERDP_API void freerdp_static_channel_collection_free(rdpSettings* settings);
248
249 WINPR_ATTR_NODISCARD
250 FREERDP_API BOOL freerdp_dynamic_channel_collection_add(rdpSettings* settings,
251 ADDIN_ARGV* channel);
252
253 FREERDP_API BOOL freerdp_dynamic_channel_collection_del(rdpSettings* settings,
254 const char* name);
255
256 WINPR_ATTR_NODISCARD
257 FREERDP_API ADDIN_ARGV* freerdp_dynamic_channel_collection_find(const rdpSettings* settings,
258 const char* name);
259
260#if defined(WITH_FREERDP_DEPRECATED)
261 WINPR_DEPRECATED(
262 WINPR_ATTR_NODISCARD FREERDP_API ADDIN_ARGV* WINPR_ATTR_MALLOC(freerdp_addin_argv_free, 1)
263 WINPR_ATTR_NODISCARD freerdp_dynamic_channel_clone(ADDIN_ARGV* channel));
264#endif
265
266 FREERDP_API void freerdp_dynamic_channel_collection_free(rdpSettings* settings);
267 FREERDP_API void freerdp_capability_buffer_free(rdpSettings* settings);
268
269 WINPR_ATTR_NODISCARD
270 FREERDP_API BOOL freerdp_capability_buffer_copy(rdpSettings* settings, const rdpSettings* src);
271
272 FREERDP_API void freerdp_server_license_issuers_free(rdpSettings* settings);
273
274 WINPR_ATTR_NODISCARD
275 FREERDP_API BOOL freerdp_server_license_issuers_copy(rdpSettings* settings, char** issuers,
276 UINT32 count);
277
278 FREERDP_API void freerdp_target_net_addresses_free(rdpSettings* settings);
279
280 WINPR_ATTR_NODISCARD
281 FREERDP_API BOOL freerdp_target_net_addresses_copy(rdpSettings* settings, char** addresses,
282 UINT32 count);
283
284 FREERDP_API void freerdp_performance_flags_make(rdpSettings* settings);
285 FREERDP_API void freerdp_performance_flags_split(rdpSettings* settings);
286
287 FREERDP_API BOOL freerdp_set_gateway_usage_method(rdpSettings* settings,
288 UINT32 GatewayUsageMethod);
289 FREERDP_API void freerdp_update_gateway_usage_method(rdpSettings* settings,
290 UINT32 GatewayEnabled,
291 UINT32 GatewayBypassLocal);
292
293 /* DEPRECATED:
294 * the functions freerdp_get_param_* and freerdp_set_param_* are deprecated.
295 * use freerdp_settings_get_* and freerdp_settings_set_* as a replacement!
296 */
297#if defined(WITH_FREERDP_DEPRECATED)
298 WINPR_DEPRECATED_VAR("Use freerdp_settings_get_bool instead",
299 WINPR_ATTR_NODISCARD FREERDP_API BOOL
300 freerdp_get_param_bool(const rdpSettings* settings, int id));
301 WINPR_DEPRECATED_VAR("Use freerdp_settings_set_bool instead",
302 FREERDP_API int freerdp_set_param_bool(rdpSettings* settings, int id,
303 BOOL param));
304
305 WINPR_DEPRECATED_VAR("Use freerdp_settings_get_int[16|32] instead",
306 WINPR_ATTR_NODISCARD FREERDP_API int freerdp_get_param_int(
307 const rdpSettings* settings, int id));
308 WINPR_DEPRECATED_VAR("Use freerdp_settings_set_int[16|32] instead",
309 FREERDP_API int freerdp_set_param_int(rdpSettings* settings, int id,
310 int param));
311
312 WINPR_DEPRECATED_VAR("Use freerdp_settings_get_uint32 instead",
313 WINPR_ATTR_NODISCARD FREERDP_API UINT32
314 freerdp_get_param_uint32(const rdpSettings* settings, int id));
315 WINPR_DEPRECATED_VAR("Use freerdp_settings_set_uint32 instead",
316 FREERDP_API int freerdp_set_param_uint32(rdpSettings* settings, int id,
317 UINT32 param));
318
319 WINPR_DEPRECATED_VAR("Use freerdp_settings_get_uint64 instead",
320 WINPR_ATTR_NODISCARD FREERDP_API UINT64
321 freerdp_get_param_uint64(const rdpSettings* settings, int id));
322 WINPR_DEPRECATED_VAR("Use freerdp_settings_set_uint64 instead",
323 FREERDP_API int freerdp_set_param_uint64(rdpSettings* settings, int id,
324 UINT64 param));
325
326 WINPR_DEPRECATED_VAR("Use freerdp_settings_get_string instead",
327 WINPR_ATTR_NODISCARD FREERDP_API char* freerdp_get_param_string(
328 const rdpSettings* settings, int id));
329 WINPR_DEPRECATED_VAR("Use freerdp_settings_set_string instead",
330 FREERDP_API int freerdp_set_param_string(rdpSettings* settings, int id,
331 const char* param));
332#endif
333
343 WINPR_ATTR_NODISCARD
344 FREERDP_API BOOL freerdp_settings_are_valid(const rdpSettings* settings);
345
353 WINPR_ATTR_NODISCARD
354 FREERDP_API BOOL freerdp_settings_get_bool(const rdpSettings* settings,
355 FreeRDP_Settings_Keys_Bool id);
356
365 FREERDP_API BOOL freerdp_settings_set_bool(rdpSettings* settings, FreeRDP_Settings_Keys_Bool id,
366 BOOL val);
367
375 WINPR_ATTR_NODISCARD
376 FREERDP_API INT16 freerdp_settings_get_int16(const rdpSettings* settings,
377 FreeRDP_Settings_Keys_Int16 id);
378
387 FREERDP_API BOOL freerdp_settings_set_int16(rdpSettings* settings,
388 FreeRDP_Settings_Keys_Int16 id, INT16 val);
389
397 WINPR_ATTR_NODISCARD
398 FREERDP_API UINT16 freerdp_settings_get_uint16(const rdpSettings* settings,
399 FreeRDP_Settings_Keys_UInt16 id);
400
409 FREERDP_API BOOL freerdp_settings_set_uint16(rdpSettings* settings,
410 FreeRDP_Settings_Keys_UInt16 id, UINT16 val);
411
419 WINPR_ATTR_NODISCARD
420 FREERDP_API INT32 freerdp_settings_get_int32(const rdpSettings* settings,
421 FreeRDP_Settings_Keys_Int32 id);
422
431 FREERDP_API BOOL freerdp_settings_set_int32(rdpSettings* settings,
432 FreeRDP_Settings_Keys_Int32 id, INT32 val);
433
441 WINPR_ATTR_NODISCARD
442 FREERDP_API UINT32 freerdp_settings_get_uint32(const rdpSettings* settings,
443 FreeRDP_Settings_Keys_UInt32 id);
444
453 FREERDP_API BOOL freerdp_settings_set_uint32(rdpSettings* settings,
454 FreeRDP_Settings_Keys_UInt32 id, UINT32 val);
455
463 WINPR_ATTR_NODISCARD
464 FREERDP_API INT64 freerdp_settings_get_int64(const rdpSettings* settings,
465 FreeRDP_Settings_Keys_Int64 id);
466
475 FREERDP_API BOOL freerdp_settings_set_int64(rdpSettings* settings,
476 FreeRDP_Settings_Keys_Int64 id, INT64 val);
477
485 WINPR_ATTR_NODISCARD
486 FREERDP_API UINT64 freerdp_settings_get_uint64(const rdpSettings* settings,
487 FreeRDP_Settings_Keys_UInt64 id);
488
497 FREERDP_API BOOL freerdp_settings_set_uint64(rdpSettings* settings,
498 FreeRDP_Settings_Keys_UInt64 id, UINT64 val);
499
507 WINPR_ATTR_NODISCARD
508 FREERDP_API const char* freerdp_settings_get_string(const rdpSettings* settings,
509 FreeRDP_Settings_Keys_String id);
510
518 WINPR_ATTR_NODISCARD
519 FREERDP_API char* freerdp_settings_get_string_writable(rdpSettings* settings,
520 FreeRDP_Settings_Keys_String id);
521
531 FREERDP_API BOOL freerdp_settings_set_string_len(rdpSettings* settings,
532 FreeRDP_Settings_Keys_String id,
533 const char* val, size_t len);
534
544 FREERDP_API BOOL freerdp_settings_set_string(rdpSettings* settings,
545 FreeRDP_Settings_Keys_String id, const char* val);
546
558 WINPR_ATTR_NODISCARD
559 FREERDP_API BOOL freerdp_settings_append_string(rdpSettings* settings,
560 FreeRDP_Settings_Keys_String id,
561 const char* separator, const char* param);
562
572 FREERDP_API BOOL freerdp_settings_set_string_from_utf16(rdpSettings* settings,
573 FreeRDP_Settings_Keys_String id,
574 const WCHAR* param);
575
586 FREERDP_API BOOL freerdp_settings_set_string_from_utf16N(rdpSettings* settings,
587 FreeRDP_Settings_Keys_String id,
588 const WCHAR* param, size_t length);
596 WINPR_ATTR_MALLOC(free, 1)
597 WINPR_ATTR_NODISCARD
598 FREERDP_API WCHAR* freerdp_settings_get_string_as_utf16(const rdpSettings* settings,
599 FreeRDP_Settings_Keys_String id,
600 size_t* pCharLen);
601
609 WINPR_ATTR_NODISCARD
610 FREERDP_API const void* freerdp_settings_get_pointer(const rdpSettings* settings,
611 FreeRDP_Settings_Keys_Pointer id);
612
620 WINPR_ATTR_NODISCARD
621 FREERDP_API void* freerdp_settings_get_pointer_writable(rdpSettings* settings,
622 FreeRDP_Settings_Keys_Pointer id);
623
632 FREERDP_API BOOL freerdp_settings_set_pointer(rdpSettings* settings,
633 FreeRDP_Settings_Keys_Pointer id,
634 const void* val);
635
644 FREERDP_API BOOL freerdp_settings_set_pointer_len(rdpSettings* settings,
645 FreeRDP_Settings_Keys_Pointer id,
646 const void* data, size_t len);
647
648 WINPR_ATTR_NODISCARD
649 FREERDP_API const void* freerdp_settings_get_pointer_array(const rdpSettings* settings,
650 FreeRDP_Settings_Keys_Pointer id,
651 size_t offset);
652
653 WINPR_ATTR_NODISCARD
654 FREERDP_API void* freerdp_settings_get_pointer_array_writable(const rdpSettings* settings,
655 FreeRDP_Settings_Keys_Pointer id,
656 size_t offset);
657
658 FREERDP_API BOOL freerdp_settings_set_pointer_array(rdpSettings* settings,
659 FreeRDP_Settings_Keys_Pointer id,
660 size_t offset, const void* data);
661
682 FREERDP_API BOOL freerdp_settings_set_value_for_name(rdpSettings* settings, const char* name,
683 const char* value);
684
691 WINPR_ATTR_NODISCARD
692 FREERDP_API SSIZE_T freerdp_settings_get_key_for_name(const char* value);
693
701 WINPR_ATTR_NODISCARD
702 FREERDP_API SSIZE_T freerdp_settings_get_type_for_name(const char* value);
703
711 WINPR_ATTR_NODISCARD
712 FREERDP_API SSIZE_T freerdp_settings_get_type_for_key(SSIZE_T key);
713
719 WINPR_ATTR_NODISCARD
720 FREERDP_API const char* freerdp_settings_get_type_name_for_key(SSIZE_T key);
721
727 WINPR_ATTR_NODISCARD
728 FREERDP_API const char* freerdp_settings_get_type_name_for_type(SSIZE_T type);
729
735 WINPR_ATTR_NODISCARD
736 FREERDP_API const char* freerdp_settings_get_name_for_key(SSIZE_T key);
737
747 WINPR_ATTR_NODISCARD
748 FREERDP_API UINT32 freerdp_settings_get_codecs_flags(const rdpSettings* settings);
749
765 WINPR_ATTR_NODISCARD
766 FREERDP_API BOOL freerdp_settings_update_from_caps(rdpSettings* settings, const BYTE* capsFlags,
767 const BYTE** capsData,
768 const UINT32* capsSizes, UINT32 capsCount,
769 BOOL serverReceivedCaps);
770
780 WINPR_ATTR_NODISCARD
781 FREERDP_API const char* freerdp_settings_get_server_name(const rdpSettings* settings);
782
791 WINPR_ATTR_NODISCARD
792 FREERDP_API const char* freerdp_rail_support_flags_to_string(UINT32 flags, char* buffer,
793 size_t length);
794
802 WINPR_ATTR_NODISCARD
803 FREERDP_API const char* freerdp_rdp_version_string(UINT32 version);
804
811 WINPR_ATTR_NODISCARD
812 FREERDP_API const char* freerdp_rdpdr_dtyp_string(UINT32 type);
813
814 WINPR_ATTR_NODISCARD
815 FREERDP_API const char* freerdp_encryption_level_string(UINT32 EncryptionLevel);
816
817 WINPR_ATTR_NODISCARD
818 FREERDP_API const char* freerdp_encryption_methods_string(UINT32 EncryptionMethods,
819 char* buffer, size_t size);
820
828 WINPR_ATTR_NODISCARD
829 FREERDP_API const char* freerdp_supported_color_depths_string(UINT16 mask, char* buffer,
830 size_t size);
831
837 WINPR_ATTR_MALLOC(free, 1)
838 WINPR_ATTR_NODISCARD
839 FREERDP_API char* freerdp_settings_get_config_path(void);
840
858 WINPR_ATTR_NODISCARD
859 FREERDP_API BOOL freerdp_settings_set_monitor_def_array_sorted(rdpSettings* settings,
860 const rdpMonitor* monitors,
861 size_t count);
862
872 WINPR_ATTR_MALLOC(free, 1)
873 WINPR_ATTR_NODISCARD
874 FREERDP_API char* freerdp_settings_serialize(const rdpSettings* settings, BOOL pretty,
875 size_t* plength);
876
884 WINPR_ATTR_MALLOC(freerdp_settings_free, 1)
885 WINPR_ATTR_NODISCARD
886 FREERDP_API rdpSettings* freerdp_settings_deserialize(const char* jstr, size_t length);
887
888#ifdef __cplusplus
889}
890#endif
891
894#endif /* FREERDP_SETTINGS_H */
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.
Definition settings_str.c:249
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.
Definition common/settings.c:1414
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.
Definition settings_str.c:383
freerdp_settings_set_uint32
FREERDP_API BOOL freerdp_settings_set_uint32(rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id, UINT32 val)
Sets a UINT32 settings value.
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.
Definition common/settings.c:2175
freerdp_settings_set_bool
FREERDP_API BOOL freerdp_settings_set_bool(rdpSettings *settings, FreeRDP_Settings_Keys_Bool id, BOOL val)
Sets a BOOL settings value.
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.
Definition settings_getters.c:3048
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.
Definition common/settings.c:2009
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.
freerdp_settings_clone
WINPR_ATTR_NODISCARD FREERDP_API rdpSettings * freerdp_settings_clone(const rdpSettings *settings)
Creates a deep copy of settings.
Definition core/settings.c:1614
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
Definition settings_str.c:432
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.
Definition common/settings.c:2258
freerdp_device_collection_del
WINPR_ATTR_NODISCARD 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.
Definition common/settings.c:240
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.
Definition settings_str.c:364
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.
freerdp_settings_get_config_path
WINPR_ATTR_NODISCARD FREERDP_API char * freerdp_settings_get_config_path(void)
return the configuration directory for the library
Definition core/settings.c:808
freerdp_settings_set_int16
FREERDP_API BOOL freerdp_settings_set_int16(rdpSettings *settings, FreeRDP_Settings_Keys_Int16 id, INT16 val)
Sets a INT16 settings value.
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.
Definition common/settings.c:1426
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.
Definition settings_getters.c:4088
freerdp_settings_deserialize
WINPR_ATTR_NODISCARD FREERDP_API rdpSettings * freerdp_settings_deserialize(const char *jstr, size_t length)
A function that converts a JSON string to a rdpSettings struct.
Definition common/settings.c:4290
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.
Definition common/settings.c:1994
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.
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.
freerdp_settings_copy
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_copy(rdpSettings *dst, const rdpSettings *src)
Deep copies settings from src to dst.
Definition core/settings.c:1588
freerdp_settings_set_pointer
FREERDP_API BOOL freerdp_settings_set_pointer(rdpSettings *settings, FreeRDP_Settings_Keys_Pointer id, const void *val)
Set a pointer to value val.
freerdp_settings_set_uint64
FREERDP_API BOOL freerdp_settings_set_uint64(rdpSettings *settings, FreeRDP_Settings_Keys_UInt64 id, UINT64 val)
Sets a UINT64 settings value.
freerdp_settings_free
FREERDP_API void freerdp_settings_free(rdpSettings *settings)
Free a settings struct with all data in it.
Definition core/settings.c:1372
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.
Definition settings_str.c:377
freerdp_settings_append_string
WINPR_ATTR_NODISCARD 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 no...
Definition common/settings.c:2383
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.
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.
Definition settings_str.c:351
freerdp_settings_new
WINPR_ATTR_NODISCARD FREERDP_API rdpSettings * freerdp_settings_new(DWORD flags)
creates a new setting struct
Definition core/settings.c:813
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.
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.
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.
Definition common/settings.c:2202
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.
Definition common/settings.c:2403
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.
Definition common/settings.c:3684
freerdp_settings_set_int32
FREERDP_API BOOL freerdp_settings_set_int32(rdpSettings *settings, FreeRDP_Settings_Keys_Int32 id, INT32 val)
Sets a INT32 settings value.
freerdp_set_gateway_usage_method
FREERDP_API BOOL freerdp_set_gateway_usage_method(rdpSettings *settings, UINT32 GatewayUsageMethod)
Definition common/settings.c:1110
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.
Definition common/settings.c:2281
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.
Definition common/settings.c:2241
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:
Definition common/settings.c:2432
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.
Definition common/settings.c:2140
freerdp_settings_set_int64
FREERDP_API BOOL freerdp_settings_set_int64(rdpSettings *settings, FreeRDP_Settings_Keys_Int64 id, INT64 val)
Sets a INT64 settings value.
freerdp_rdpdr_dtyp_string
WINPR_ATTR_NODISCARD FREERDP_API const char * freerdp_rdpdr_dtyp_string(UINT32 type)
Returns a string representation of RDPDR_DTYP_*.
Definition common/settings.c:2292
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
Definition common/settings.c:2358
freerdp_settings_set_uint16
FREERDP_API BOOL freerdp_settings_set_uint16(rdpSettings *settings, FreeRDP_Settings_Keys_UInt16 id, UINT16 val)
Sets a UINT16 settings value.
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.
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.
Definition settings_str.c:421
freerdp_settings_set_string_len
FREERDP_API BOOL freerdp_settings_set_string_len(rdpSettings *settings, FreeRDP_Settings_Keys_String id, const char *val, size_t len)
Sets a string settings value. The val is copied.
Definition settings_getters.c:3723
freerdp_settings_set_string
FREERDP_API BOOL freerdp_settings_set_string(rdpSettings *settings, FreeRDP_Settings_Keys_String id, const char *val)
Sets a string settings value. The param is copied.
Definition settings_getters.c:3729
freerdp_settings_print_diff
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_print_diff(wLog *log, DWORD level, const rdpSettings *settings, const rdpSettings *other)
Dumps the difference between two settings structs to a WLog.
Definition settings_str.c:99
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.
Definition settings_str.c:410
ADDIN_ARGV
Definition settings_types.h:375
RDPDR_DEVICE
Definition settings_types.h:452
rdpMonitor
Definition settings_types.h:431
rdp_settings
Definition settings_types_private.h:51