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 FREERDP_API rdpSettings* freerdp_settings_new(DWORD flags);
98
105 WINPR_ATTR_MALLOC(freerdp_settings_free, 1)
106 FREERDP_API rdpSettings* freerdp_settings_clone(const rdpSettings* settings);
107
117 WINPR_ATTR_NODISCARD
118 FREERDP_API BOOL freerdp_settings_copy(rdpSettings* dst, const rdpSettings* src);
119
130 WINPR_ATTR_NODISCARD
131 FREERDP_API BOOL freerdp_settings_copy_item(rdpSettings* dst, const rdpSettings* src,
132 SSIZE_T id);
133
140 FREERDP_API void freerdp_settings_dump(wLog* log, DWORD level, const rdpSettings* settings);
141
151 WINPR_ATTR_NODISCARD
152 FREERDP_API BOOL freerdp_settings_print_diff(wLog* log, DWORD level,
153 const rdpSettings* settings,
154 const rdpSettings* other);
155
156 FREERDP_API void freerdp_addin_argv_free(ADDIN_ARGV* args);
157
158 WINPR_ATTR_MALLOC(freerdp_addin_argv_free, 1)
159 FREERDP_API ADDIN_ARGV* freerdp_addin_argv_new(size_t argc, const char* const argv[]);
160
161 WINPR_ATTR_MALLOC(freerdp_addin_argv_free, 1)
162 FREERDP_API ADDIN_ARGV* freerdp_addin_argv_clone(const ADDIN_ARGV* args);
163
164 WINPR_ATTR_NODISCARD
165 FREERDP_API BOOL freerdp_addin_argv_add_argument(ADDIN_ARGV* args, const char* argument);
166
167 WINPR_ATTR_NODISCARD
168 FREERDP_API BOOL freerdp_addin_argv_add_argument_ex(ADDIN_ARGV* args, const char* argument,
169 size_t len);
170
171 WINPR_ATTR_NODISCARD
172 FREERDP_API BOOL freerdp_addin_argv_del_argument(ADDIN_ARGV* args, const char* argument);
173
174 WINPR_ATTR_NODISCARD
175 FREERDP_API int freerdp_addin_set_argument(ADDIN_ARGV* args, const char* argument);
176
177 WINPR_ATTR_NODISCARD
178 FREERDP_API int freerdp_addin_replace_argument(ADDIN_ARGV* args, const char* previous,
179 const char* argument);
180
181 WINPR_ATTR_NODISCARD
182 FREERDP_API int freerdp_addin_set_argument_value(ADDIN_ARGV* args, const char* option,
183 const char* value);
184
185 WINPR_ATTR_NODISCARD
186 FREERDP_API int freerdp_addin_replace_argument_value(ADDIN_ARGV* args, const char* previous,
187 const char* option, const char* value);
188
189 WINPR_ATTR_NODISCARD
190 FREERDP_API BOOL freerdp_device_collection_add(rdpSettings* settings, RDPDR_DEVICE* device);
191
202 WINPR_ATTR_NODISCARD
203 FREERDP_API BOOL freerdp_device_collection_del(rdpSettings* settings,
204 const RDPDR_DEVICE* device);
205 WINPR_ATTR_NODISCARD
206 FREERDP_API RDPDR_DEVICE* freerdp_device_collection_find(rdpSettings* settings,
207 const char* name);
208 WINPR_ATTR_NODISCARD
209 FREERDP_API RDPDR_DEVICE* freerdp_device_collection_find_type(rdpSettings* settings,
210 UINT32 type);
211
212 FREERDP_API void freerdp_device_free(RDPDR_DEVICE* device);
213
214 WINPR_ATTR_MALLOC(freerdp_device_free, 1)
215 FREERDP_API RDPDR_DEVICE* freerdp_device_new(UINT32 Type, size_t count,
216 const char* const args[]);
217
218 WINPR_ATTR_MALLOC(freerdp_device_free, 1)
219 FREERDP_API RDPDR_DEVICE* freerdp_device_clone(const RDPDR_DEVICE* device);
220
221 WINPR_ATTR_NODISCARD
222 FREERDP_API BOOL freerdp_device_equal(const RDPDR_DEVICE* what, const RDPDR_DEVICE* other);
223
224 FREERDP_API void freerdp_device_collection_free(rdpSettings* settings);
225
226 WINPR_ATTR_NODISCARD
227 FREERDP_API BOOL freerdp_static_channel_collection_add(rdpSettings* settings,
228 ADDIN_ARGV* channel);
229
230 FREERDP_API BOOL freerdp_static_channel_collection_del(rdpSettings* settings, const char* name);
231
232 WINPR_ATTR_NODISCARD
233 FREERDP_API ADDIN_ARGV* freerdp_static_channel_collection_find(rdpSettings* settings,
234 const char* name);
235#if defined(WITH_FREERDP_DEPRECATED)
236 WINPR_DEPRECATED(WINPR_ATTR_MALLOC(freerdp_addin_argv_free, 1)
237 FREERDP_API ADDIN_ARGV* freerdp_static_channel_clone(ADDIN_ARGV* channel));
238#endif
239
240 FREERDP_API void freerdp_static_channel_collection_free(rdpSettings* settings);
241
242 WINPR_ATTR_NODISCARD
243 FREERDP_API BOOL freerdp_dynamic_channel_collection_add(rdpSettings* settings,
244 ADDIN_ARGV* channel);
245
246 FREERDP_API BOOL freerdp_dynamic_channel_collection_del(rdpSettings* settings,
247 const char* name);
248
249 WINPR_ATTR_NODISCARD
250 FREERDP_API ADDIN_ARGV* freerdp_dynamic_channel_collection_find(const rdpSettings* settings,
251 const char* name);
252
253#if defined(WITH_FREERDP_DEPRECATED)
254 WINPR_DEPRECATED(
255 WINPR_ATTR_MALLOC(freerdp_addin_argv_free, 1)
256 FREERDP_API ADDIN_ARGV* freerdp_dynamic_channel_clone(ADDIN_ARGV* channel));
257#endif
258
259 FREERDP_API void freerdp_dynamic_channel_collection_free(rdpSettings* settings);
260 FREERDP_API void freerdp_capability_buffer_free(rdpSettings* settings);
261
262 WINPR_ATTR_NODISCARD
263 FREERDP_API BOOL freerdp_capability_buffer_copy(rdpSettings* settings, const rdpSettings* src);
264
265 FREERDP_API void freerdp_server_license_issuers_free(rdpSettings* settings);
266
267 WINPR_ATTR_NODISCARD
268 FREERDP_API BOOL freerdp_server_license_issuers_copy(rdpSettings* settings, char** issuers,
269 UINT32 count);
270
271 FREERDP_API void freerdp_target_net_addresses_free(rdpSettings* settings);
272
273 WINPR_ATTR_NODISCARD
274 FREERDP_API BOOL freerdp_target_net_addresses_copy(rdpSettings* settings, char** addresses,
275 UINT32 count);
276
277 FREERDP_API void freerdp_performance_flags_make(rdpSettings* settings);
278 FREERDP_API void freerdp_performance_flags_split(rdpSettings* settings);
279
280 WINPR_ATTR_NODISCARD
281 FREERDP_API BOOL freerdp_set_gateway_usage_method(rdpSettings* settings,
282 UINT32 GatewayUsageMethod);
283 WINPR_ATTR_NODISCARD
284 FREERDP_API UINT32 freerdp_get_gateway_usage_method(const rdpSettings* settings);
285
286 FREERDP_API void freerdp_update_gateway_usage_method(rdpSettings* settings,
287 UINT32 GatewayEnabled,
288 UINT32 GatewayBypassLocal);
289
290 /* DEPRECATED:
291 * the functions freerdp_get_param_* and freerdp_set_param_* are deprecated.
292 * use freerdp_settings_get_* and freerdp_settings_set_* as a replacement!
293 */
294#if defined(WITH_FREERDP_DEPRECATED)
295 WINPR_DEPRECATED_VAR("Use freerdp_settings_get_bool instead",
296 WINPR_ATTR_NODISCARD FREERDP_API BOOL
297 freerdp_get_param_bool(const rdpSettings* settings, int id));
298 WINPR_DEPRECATED_VAR("Use freerdp_settings_set_bool instead",
299 FREERDP_API int freerdp_set_param_bool(rdpSettings* settings, int id,
300 BOOL param));
301
302 WINPR_DEPRECATED_VAR("Use freerdp_settings_get_int[16|32] instead",
303 WINPR_ATTR_NODISCARD FREERDP_API int freerdp_get_param_int(
304 const rdpSettings* settings, int id));
305 WINPR_DEPRECATED_VAR("Use freerdp_settings_set_int[16|32] instead",
306 FREERDP_API int freerdp_set_param_int(rdpSettings* settings, int id,
307 int param));
308
309 WINPR_DEPRECATED_VAR("Use freerdp_settings_get_uint32 instead",
310 WINPR_ATTR_NODISCARD FREERDP_API UINT32
311 freerdp_get_param_uint32(const rdpSettings* settings, int id));
312 WINPR_DEPRECATED_VAR("Use freerdp_settings_set_uint32 instead",
313 FREERDP_API int freerdp_set_param_uint32(rdpSettings* settings, int id,
314 UINT32 param));
315
316 WINPR_DEPRECATED_VAR("Use freerdp_settings_get_uint64 instead",
317 WINPR_ATTR_NODISCARD FREERDP_API UINT64
318 freerdp_get_param_uint64(const rdpSettings* settings, int id));
319 WINPR_DEPRECATED_VAR("Use freerdp_settings_set_uint64 instead",
320 FREERDP_API int freerdp_set_param_uint64(rdpSettings* settings, int id,
321 UINT64 param));
322
323 WINPR_DEPRECATED_VAR("Use freerdp_settings_get_string instead",
324 WINPR_ATTR_NODISCARD FREERDP_API char* freerdp_get_param_string(
325 const rdpSettings* settings, int id));
326 WINPR_DEPRECATED_VAR("Use freerdp_settings_set_string instead",
327 FREERDP_API int freerdp_set_param_string(rdpSettings* settings, int id,
328 const char* param));
329#endif
330
340 WINPR_ATTR_NODISCARD
341 FREERDP_API BOOL freerdp_settings_are_valid(const rdpSettings* settings);
342
350 WINPR_ATTR_NODISCARD
351 FREERDP_API BOOL freerdp_settings_get_bool(const rdpSettings* settings,
352 FreeRDP_Settings_Keys_Bool id);
353
362 WINPR_ATTR_NODISCARD
363 FREERDP_API BOOL freerdp_settings_set_bool(rdpSettings* settings, FreeRDP_Settings_Keys_Bool id,
364 BOOL val);
365
373 WINPR_ATTR_NODISCARD
374 FREERDP_API INT16 freerdp_settings_get_int16(const rdpSettings* settings,
375 FreeRDP_Settings_Keys_Int16 id);
376
385 WINPR_ATTR_NODISCARD
386 FREERDP_API BOOL freerdp_settings_set_int16(rdpSettings* settings,
387 FreeRDP_Settings_Keys_Int16 id, INT16 val);
388
396 WINPR_ATTR_NODISCARD
397 FREERDP_API UINT16 freerdp_settings_get_uint16(const rdpSettings* settings,
398 FreeRDP_Settings_Keys_UInt16 id);
399
408 WINPR_ATTR_NODISCARD
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 WINPR_ATTR_NODISCARD
432 FREERDP_API BOOL freerdp_settings_set_int32(rdpSettings* settings,
433 FreeRDP_Settings_Keys_Int32 id, INT32 val);
434
442 WINPR_ATTR_NODISCARD
443 FREERDP_API UINT32 freerdp_settings_get_uint32(const rdpSettings* settings,
444 FreeRDP_Settings_Keys_UInt32 id);
445
454 WINPR_ATTR_NODISCARD
455 FREERDP_API BOOL freerdp_settings_set_uint32(rdpSettings* settings,
456 FreeRDP_Settings_Keys_UInt32 id, UINT32 val);
457
465 WINPR_ATTR_NODISCARD
466 FREERDP_API INT64 freerdp_settings_get_int64(const rdpSettings* settings,
467 FreeRDP_Settings_Keys_Int64 id);
468
477 WINPR_ATTR_NODISCARD
478 FREERDP_API BOOL freerdp_settings_set_int64(rdpSettings* settings,
479 FreeRDP_Settings_Keys_Int64 id, INT64 val);
480
488 WINPR_ATTR_NODISCARD
489 FREERDP_API UINT64 freerdp_settings_get_uint64(const rdpSettings* settings,
490 FreeRDP_Settings_Keys_UInt64 id);
491
500 WINPR_ATTR_NODISCARD
501 FREERDP_API BOOL freerdp_settings_set_uint64(rdpSettings* settings,
502 FreeRDP_Settings_Keys_UInt64 id, UINT64 val);
503
511 WINPR_ATTR_NODISCARD
512 FREERDP_API const char* freerdp_settings_get_string(const rdpSettings* settings,
513 FreeRDP_Settings_Keys_String id);
514
522 WINPR_ATTR_NODISCARD
523 FREERDP_API char* freerdp_settings_get_string_writable(rdpSettings* settings,
524 FreeRDP_Settings_Keys_String id);
525
535 WINPR_ATTR_NODISCARD
536 FREERDP_API BOOL freerdp_settings_set_string_len(rdpSettings* settings,
537 FreeRDP_Settings_Keys_String id,
538 const char* val, size_t len);
539
549 WINPR_ATTR_NODISCARD
550 FREERDP_API BOOL freerdp_settings_set_string(rdpSettings* settings,
551 FreeRDP_Settings_Keys_String id, const char* val);
552
564 WINPR_ATTR_NODISCARD
565 FREERDP_API BOOL freerdp_settings_append_string(rdpSettings* settings,
566 FreeRDP_Settings_Keys_String id,
567 const char* separator, const char* param);
568
578 WINPR_ATTR_NODISCARD
579 FREERDP_API BOOL freerdp_settings_set_string_from_utf16(rdpSettings* settings,
580 FreeRDP_Settings_Keys_String id,
581 const WCHAR* param);
582
593 WINPR_ATTR_NODISCARD
594 FREERDP_API BOOL freerdp_settings_set_string_from_utf16N(rdpSettings* settings,
595 FreeRDP_Settings_Keys_String id,
596 const WCHAR* param, size_t length);
604 WINPR_ATTR_MALLOC(free, 1)
605 FREERDP_API WCHAR* freerdp_settings_get_string_as_utf16(const rdpSettings* settings,
606 FreeRDP_Settings_Keys_String id,
607 size_t* pCharLen);
608
616 WINPR_ATTR_NODISCARD
617 FREERDP_API const void* freerdp_settings_get_pointer(const rdpSettings* settings,
618 FreeRDP_Settings_Keys_Pointer id);
619
627 WINPR_ATTR_NODISCARD
628 FREERDP_API void* freerdp_settings_get_pointer_writable(rdpSettings* settings,
629 FreeRDP_Settings_Keys_Pointer id);
630
639 WINPR_ATTR_NODISCARD
640 FREERDP_API BOOL freerdp_settings_set_pointer(rdpSettings* settings,
641 FreeRDP_Settings_Keys_Pointer id,
642 const void* val);
643
652 WINPR_ATTR_NODISCARD
653 FREERDP_API BOOL freerdp_settings_set_pointer_len(rdpSettings* settings,
654 FreeRDP_Settings_Keys_Pointer id,
655 const void* data, size_t len);
656
657 WINPR_ATTR_NODISCARD
658 FREERDP_API const void* freerdp_settings_get_pointer_array(const rdpSettings* settings,
659 FreeRDP_Settings_Keys_Pointer id,
660 size_t offset);
661
662 WINPR_ATTR_NODISCARD
663 FREERDP_API void* freerdp_settings_get_pointer_array_writable(const rdpSettings* settings,
664 FreeRDP_Settings_Keys_Pointer id,
665 size_t offset);
666
667 WINPR_ATTR_NODISCARD
668 FREERDP_API BOOL freerdp_settings_set_pointer_array(rdpSettings* settings,
669 FreeRDP_Settings_Keys_Pointer id,
670 size_t offset, const void* data);
671
692 WINPR_ATTR_NODISCARD
693 FREERDP_API BOOL freerdp_settings_set_value_for_name(rdpSettings* settings, const char* name,
694 const char* value);
695
702 WINPR_ATTR_NODISCARD
703 FREERDP_API SSIZE_T freerdp_settings_get_key_for_name(const char* value);
704
712 WINPR_ATTR_NODISCARD
713 FREERDP_API SSIZE_T freerdp_settings_get_type_for_name(const char* value);
714
722 WINPR_ATTR_NODISCARD
723 FREERDP_API SSIZE_T freerdp_settings_get_type_for_key(SSIZE_T key);
724
730 WINPR_ATTR_NODISCARD
731 FREERDP_API const char* freerdp_settings_get_type_name_for_key(SSIZE_T key);
732
738 WINPR_ATTR_NODISCARD
739 FREERDP_API const char* freerdp_settings_get_type_name_for_type(SSIZE_T type);
740
746 WINPR_ATTR_NODISCARD
747 FREERDP_API const char* freerdp_settings_get_name_for_key(SSIZE_T key);
748
758 WINPR_ATTR_NODISCARD
759 FREERDP_API UINT32 freerdp_settings_get_codecs_flags(const rdpSettings* settings);
760
776 WINPR_ATTR_NODISCARD
777 FREERDP_API BOOL freerdp_settings_update_from_caps(rdpSettings* settings, const BYTE* capsFlags,
778 const BYTE** capsData,
779 const UINT32* capsSizes, UINT32 capsCount,
780 BOOL serverReceivedCaps);
781
791 WINPR_ATTR_NODISCARD
792 FREERDP_API const char* freerdp_settings_get_server_name(const rdpSettings* settings);
793
802 WINPR_ATTR_NODISCARD
803 FREERDP_API const char* freerdp_rail_support_flags_to_string(UINT32 flags, char* buffer,
804 size_t length);
805
813 WINPR_ATTR_NODISCARD
814 FREERDP_API const char* freerdp_rdp_version_string(UINT32 version);
815
822 WINPR_ATTR_NODISCARD
823 FREERDP_API const char* freerdp_rdpdr_dtyp_string(UINT32 type);
824
825 WINPR_ATTR_NODISCARD
826 FREERDP_API const char* freerdp_encryption_level_string(UINT32 EncryptionLevel);
827
828 WINPR_ATTR_NODISCARD
829 FREERDP_API const char* freerdp_encryption_methods_string(UINT32 EncryptionMethods,
830 char* buffer, size_t size);
831
839 WINPR_ATTR_NODISCARD
840 FREERDP_API const char* freerdp_supported_color_depths_string(UINT16 mask, char* buffer,
841 size_t size);
842
848 WINPR_ATTR_MALLOC(free, 1)
849 WINPR_ATTR_NODISCARD
850 FREERDP_API char* freerdp_settings_get_config_path(void);
851
869 WINPR_ATTR_NODISCARD
870 FREERDP_API BOOL freerdp_settings_set_monitor_def_array_sorted(rdpSettings* settings,
871 const rdpMonitor* monitors,
872 size_t count);
873
883 WINPR_ATTR_MALLOC(free, 1)
884 WINPR_ATTR_NODISCARD
885 FREERDP_API char* freerdp_settings_serialize(const rdpSettings* settings, BOOL pretty,
886 size_t* plength);
887
895 WINPR_ATTR_MALLOC(freerdp_settings_free, 1)
896 WINPR_ATTR_NODISCARD
897 FREERDP_API rdpSettings* freerdp_settings_deserialize(const char* jstr, size_t length);
898
899#ifdef __cplusplus
900}
901#endif
902
905#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:1475
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:394
freerdp_settings_set_string_from_utf16N
WINPR_ATTR_NODISCARD 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:2328
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:2245
freerdp_settings_set_pointer
WINPR_ATTR_NODISCARD 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_new
FREERDP_API rdpSettings * freerdp_settings_new(DWORD flags)
creates a new setting struct
Definition core/settings.c:813
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:3052
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:2079
freerdp_settings_clone
FREERDP_API rdpSettings * freerdp_settings_clone(const rdpSettings *settings)
Creates a deep copy of settings.
Definition core/settings.c:1620
freerdp_settings_set_int64
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_int64(rdpSettings *settings, FreeRDP_Settings_Keys_Int64 id, INT64 val)
Sets a INT64 settings value.
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_set_bool
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_bool(rdpSettings *settings, FreeRDP_Settings_Keys_Bool id, BOOL val)
Sets a BOOL settings value.
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:443
freerdp_settings_set_string_len
WINPR_ATTR_NODISCARD 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:3727
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:242
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:375
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_set_string_from_utf16
WINPR_ATTR_NODISCARD 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:2311
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_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:4092
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:4360
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:2064
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:1594
freerdp_settings_set_uint32
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_uint32(rdpSettings *settings, FreeRDP_Settings_Keys_UInt32 id, UINT32 val)
Sets a UINT32 settings value.
freerdp_settings_set_pointer_len
WINPR_ATTR_NODISCARD 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:1487
freerdp_settings_set_uint64
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_uint64(rdpSettings *settings, FreeRDP_Settings_Keys_UInt64 id, UINT64 val)
Sets a UINT64 settings value.
freerdp_settings_set_int16
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_int16(rdpSettings *settings, FreeRDP_Settings_Keys_Int16 id, INT16 val)
Sets a INT16 settings value.
freerdp_settings_set_int32
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_int32(rdpSettings *settings, FreeRDP_Settings_Keys_Int32 id, INT32 val)
Sets a INT32 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:388
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:2453
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:362
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_settings_get_string_as_utf16
FREERDP_API WCHAR * freerdp_settings_get_string_as_utf16(const rdpSettings *settings, FreeRDP_Settings_Keys_String id, size_t *pCharLen)
Return an allocated UTF16 string.
Definition common/settings.c:2351
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:2272
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:2473
freerdp_settings_set_uint16
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_settings_set_uint16(rdpSettings *settings, FreeRDP_Settings_Keys_UInt16 id, UINT16 val)
Sets a UINT16 settings value.
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:3753
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:2502
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:2210
freerdp_set_gateway_usage_method
WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_set_gateway_usage_method(rdpSettings *settings, UINT32 GatewayUsageMethod)
Definition common/settings.c:1155
freerdp_settings_set_string
WINPR_ATTR_NODISCARD 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:3733
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:2362
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:2428
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:432
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:421
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