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(WINPR_ATTR_MALLOC(freerdp_addin_argv_free, 1)
243 FREERDP_API ADDIN_ARGV* freerdp_static_channel_clone(ADDIN_ARGV* channel));
244#endif
245
246 FREERDP_API void freerdp_static_channel_collection_free(rdpSettings* settings);
247
248 WINPR_ATTR_NODISCARD
249 FREERDP_API BOOL freerdp_dynamic_channel_collection_add(rdpSettings* settings,
250 ADDIN_ARGV* channel);
251
252 FREERDP_API BOOL freerdp_dynamic_channel_collection_del(rdpSettings* settings,
253 const char* name);
254
255 WINPR_ATTR_NODISCARD
256 FREERDP_API ADDIN_ARGV* freerdp_dynamic_channel_collection_find(const rdpSettings* settings,
257 const char* name);
258
259#if defined(WITH_FREERDP_DEPRECATED)
260 WINPR_DEPRECATED(
261 WINPR_ATTR_MALLOC(freerdp_addin_argv_free, 1)
262 FREERDP_API ADDIN_ARGV* freerdp_dynamic_channel_clone(ADDIN_ARGV* channel));
263#endif
264
265 FREERDP_API void freerdp_dynamic_channel_collection_free(rdpSettings* settings);
266 FREERDP_API void freerdp_capability_buffer_free(rdpSettings* settings);
267
268 WINPR_ATTR_NODISCARD
269 FREERDP_API BOOL freerdp_capability_buffer_copy(rdpSettings* settings, const rdpSettings* src);
270
271 FREERDP_API void freerdp_server_license_issuers_free(rdpSettings* settings);
272
273 WINPR_ATTR_NODISCARD
274 FREERDP_API BOOL freerdp_server_license_issuers_copy(rdpSettings* settings, char** issuers,
275 UINT32 count);
276
277 FREERDP_API void freerdp_target_net_addresses_free(rdpSettings* settings);
278
279 WINPR_ATTR_NODISCARD
280 FREERDP_API BOOL freerdp_target_net_addresses_copy(rdpSettings* settings, char** addresses,
281 UINT32 count);
282
283 FREERDP_API void freerdp_performance_flags_make(rdpSettings* settings);
284 FREERDP_API void freerdp_performance_flags_split(rdpSettings* settings);
285
286 FREERDP_API BOOL freerdp_set_gateway_usage_method(rdpSettings* settings,
287 UINT32 GatewayUsageMethod);
288 FREERDP_API void freerdp_update_gateway_usage_method(rdpSettings* settings,
289 UINT32 GatewayEnabled,
290 UINT32 GatewayBypassLocal);
291
292 /* DEPRECATED:
293 * the functions freerdp_get_param_* and freerdp_set_param_* are deprecated.
294 * use freerdp_settings_get_* and freerdp_settings_set_* as a replacement!
295 */
296#if defined(WITH_FREERDP_DEPRECATED)
297 WINPR_DEPRECATED_VAR("Use freerdp_settings_get_bool instead",
298 WINPR_ATTR_NODISCARD FREERDP_API BOOL
299 freerdp_get_param_bool(const rdpSettings* settings, int id));
300 WINPR_DEPRECATED_VAR("Use freerdp_settings_set_bool instead",
301 FREERDP_API int freerdp_set_param_bool(rdpSettings* settings, int id,
302 BOOL param));
303
304 WINPR_DEPRECATED_VAR("Use freerdp_settings_get_int[16|32] instead",
305 WINPR_ATTR_NODISCARD FREERDP_API int freerdp_get_param_int(
306 const rdpSettings* settings, int id));
307 WINPR_DEPRECATED_VAR("Use freerdp_settings_set_int[16|32] instead",
308 FREERDP_API int freerdp_set_param_int(rdpSettings* settings, int id,
309 int param));
310
311 WINPR_DEPRECATED_VAR("Use freerdp_settings_get_uint32 instead",
312 WINPR_ATTR_NODISCARD FREERDP_API UINT32
313 freerdp_get_param_uint32(const rdpSettings* settings, int id));
314 WINPR_DEPRECATED_VAR("Use freerdp_settings_set_uint32 instead",
315 FREERDP_API int freerdp_set_param_uint32(rdpSettings* settings, int id,
316 UINT32 param));
317
318 WINPR_DEPRECATED_VAR("Use freerdp_settings_get_uint64 instead",
319 WINPR_ATTR_NODISCARD FREERDP_API UINT64
320 freerdp_get_param_uint64(const rdpSettings* settings, int id));
321 WINPR_DEPRECATED_VAR("Use freerdp_settings_set_uint64 instead",
322 FREERDP_API int freerdp_set_param_uint64(rdpSettings* settings, int id,
323 UINT64 param));
324
325 WINPR_DEPRECATED_VAR("Use freerdp_settings_get_string instead",
326 WINPR_ATTR_NODISCARD FREERDP_API char* freerdp_get_param_string(
327 const rdpSettings* settings, int id));
328 WINPR_DEPRECATED_VAR("Use freerdp_settings_set_string instead",
329 FREERDP_API int freerdp_set_param_string(rdpSettings* settings, int id,
330 const char* param));
331#endif
332
342 WINPR_ATTR_NODISCARD
343 FREERDP_API BOOL freerdp_settings_are_valid(const rdpSettings* settings);
344
352 WINPR_ATTR_NODISCARD
353 FREERDP_API BOOL freerdp_settings_get_bool(const rdpSettings* settings,
354 FreeRDP_Settings_Keys_Bool id);
355
364 FREERDP_API BOOL freerdp_settings_set_bool(rdpSettings* settings, FreeRDP_Settings_Keys_Bool id,
365 BOOL val);
366
374 WINPR_ATTR_NODISCARD
375 FREERDP_API INT16 freerdp_settings_get_int16(const rdpSettings* settings,
376 FreeRDP_Settings_Keys_Int16 id);
377
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 FREERDP_API BOOL freerdp_settings_set_uint16(rdpSettings* settings,
409 FreeRDP_Settings_Keys_UInt16 id, UINT16 val);
410
418 WINPR_ATTR_NODISCARD
419 FREERDP_API INT32 freerdp_settings_get_int32(const rdpSettings* settings,
420 FreeRDP_Settings_Keys_Int32 id);
421
430 FREERDP_API BOOL freerdp_settings_set_int32(rdpSettings* settings,
431 FreeRDP_Settings_Keys_Int32 id, INT32 val);
432
440 WINPR_ATTR_NODISCARD
441 FREERDP_API UINT32 freerdp_settings_get_uint32(const rdpSettings* settings,
442 FreeRDP_Settings_Keys_UInt32 id);
443
452 FREERDP_API BOOL freerdp_settings_set_uint32(rdpSettings* settings,
453 FreeRDP_Settings_Keys_UInt32 id, UINT32 val);
454
462 WINPR_ATTR_NODISCARD
463 FREERDP_API INT64 freerdp_settings_get_int64(const rdpSettings* settings,
464 FreeRDP_Settings_Keys_Int64 id);
465
474 FREERDP_API BOOL freerdp_settings_set_int64(rdpSettings* settings,
475 FreeRDP_Settings_Keys_Int64 id, INT64 val);
476
484 WINPR_ATTR_NODISCARD
485 FREERDP_API UINT64 freerdp_settings_get_uint64(const rdpSettings* settings,
486 FreeRDP_Settings_Keys_UInt64 id);
487
496 FREERDP_API BOOL freerdp_settings_set_uint64(rdpSettings* settings,
497 FreeRDP_Settings_Keys_UInt64 id, UINT64 val);
498
506 WINPR_ATTR_NODISCARD
507 FREERDP_API const char* freerdp_settings_get_string(const rdpSettings* settings,
508 FreeRDP_Settings_Keys_String id);
509
517 WINPR_ATTR_NODISCARD
518 FREERDP_API char* freerdp_settings_get_string_writable(rdpSettings* settings,
519 FreeRDP_Settings_Keys_String id);
520
530 FREERDP_API BOOL freerdp_settings_set_string_len(rdpSettings* settings,
531 FreeRDP_Settings_Keys_String id,
532 const char* val, size_t len);
533
543 FREERDP_API BOOL freerdp_settings_set_string(rdpSettings* settings,
544 FreeRDP_Settings_Keys_String id, const char* val);
545
557 WINPR_ATTR_NODISCARD
558 FREERDP_API BOOL freerdp_settings_append_string(rdpSettings* settings,
559 FreeRDP_Settings_Keys_String id,
560 const char* separator, const char* param);
561
571 FREERDP_API BOOL freerdp_settings_set_string_from_utf16(rdpSettings* settings,
572 FreeRDP_Settings_Keys_String id,
573 const WCHAR* param);
574
585 FREERDP_API BOOL freerdp_settings_set_string_from_utf16N(rdpSettings* settings,
586 FreeRDP_Settings_Keys_String id,
587 const WCHAR* param, size_t length);
595 WINPR_ATTR_MALLOC(free, 1)
596 WINPR_ATTR_NODISCARD
597 FREERDP_API WCHAR* freerdp_settings_get_string_as_utf16(const rdpSettings* settings,
598 FreeRDP_Settings_Keys_String id,
599 size_t* pCharLen);
600
608 WINPR_ATTR_NODISCARD
609 FREERDP_API const void* freerdp_settings_get_pointer(const rdpSettings* settings,
610 FreeRDP_Settings_Keys_Pointer id);
611
619 WINPR_ATTR_NODISCARD
620 FREERDP_API void* freerdp_settings_get_pointer_writable(rdpSettings* settings,
621 FreeRDP_Settings_Keys_Pointer id);
622
631 FREERDP_API BOOL freerdp_settings_set_pointer(rdpSettings* settings,
632 FreeRDP_Settings_Keys_Pointer id,
633 const void* val);
634
643 FREERDP_API BOOL freerdp_settings_set_pointer_len(rdpSettings* settings,
644 FreeRDP_Settings_Keys_Pointer id,
645 const void* data, size_t len);
646
647 WINPR_ATTR_NODISCARD
648 FREERDP_API const void* freerdp_settings_get_pointer_array(const rdpSettings* settings,
649 FreeRDP_Settings_Keys_Pointer id,
650 size_t offset);
651
652 WINPR_ATTR_NODISCARD
653 FREERDP_API void* freerdp_settings_get_pointer_array_writable(const rdpSettings* settings,
654 FreeRDP_Settings_Keys_Pointer id,
655 size_t offset);
656
657 FREERDP_API BOOL freerdp_settings_set_pointer_array(rdpSettings* settings,
658 FreeRDP_Settings_Keys_Pointer id,
659 size_t offset, const void* data);
660
681 FREERDP_API BOOL freerdp_settings_set_value_for_name(rdpSettings* settings, const char* name,
682 const char* value);
683
690 WINPR_ATTR_NODISCARD
691 FREERDP_API SSIZE_T freerdp_settings_get_key_for_name(const char* value);
692
700 WINPR_ATTR_NODISCARD
701 FREERDP_API SSIZE_T freerdp_settings_get_type_for_name(const char* value);
702
710 WINPR_ATTR_NODISCARD
711 FREERDP_API SSIZE_T freerdp_settings_get_type_for_key(SSIZE_T key);
712
718 WINPR_ATTR_NODISCARD
719 FREERDP_API const char* freerdp_settings_get_type_name_for_key(SSIZE_T key);
720
726 WINPR_ATTR_NODISCARD
727 FREERDP_API const char* freerdp_settings_get_type_name_for_type(SSIZE_T type);
728
734 WINPR_ATTR_NODISCARD
735 FREERDP_API const char* freerdp_settings_get_name_for_key(SSIZE_T key);
736
746 WINPR_ATTR_NODISCARD
747 FREERDP_API UINT32 freerdp_settings_get_codecs_flags(const rdpSettings* settings);
748
764 WINPR_ATTR_NODISCARD
765 FREERDP_API BOOL freerdp_settings_update_from_caps(rdpSettings* settings, const BYTE* capsFlags,
766 const BYTE** capsData,
767 const UINT32* capsSizes, UINT32 capsCount,
768 BOOL serverReceivedCaps);
769
779 WINPR_ATTR_NODISCARD
780 FREERDP_API const char* freerdp_settings_get_server_name(const rdpSettings* settings);
781
790 WINPR_ATTR_NODISCARD
791 FREERDP_API const char* freerdp_rail_support_flags_to_string(UINT32 flags, char* buffer,
792 size_t length);
793
801 WINPR_ATTR_NODISCARD
802 FREERDP_API const char* freerdp_rdp_version_string(UINT32 version);
803
810 WINPR_ATTR_NODISCARD
811 FREERDP_API const char* freerdp_rdpdr_dtyp_string(UINT32 type);
812
813 WINPR_ATTR_NODISCARD
814 FREERDP_API const char* freerdp_encryption_level_string(UINT32 EncryptionLevel);
815
816 WINPR_ATTR_NODISCARD
817 FREERDP_API const char* freerdp_encryption_methods_string(UINT32 EncryptionMethods,
818 char* buffer, size_t size);
819
827 WINPR_ATTR_NODISCARD
828 FREERDP_API const char* freerdp_supported_color_depths_string(UINT16 mask, char* buffer,
829 size_t size);
830
836 WINPR_ATTR_MALLOC(free, 1)
837 WINPR_ATTR_NODISCARD
838 FREERDP_API char* freerdp_settings_get_config_path(void);
839
857 WINPR_ATTR_NODISCARD
858 FREERDP_API BOOL freerdp_settings_set_monitor_def_array_sorted(rdpSettings* settings,
859 const rdpMonitor* monitors,
860 size_t count);
861
871 WINPR_ATTR_MALLOC(free, 1)
872 WINPR_ATTR_NODISCARD
873 FREERDP_API char* freerdp_settings_serialize(const rdpSettings* settings, BOOL pretty,
874 size_t* plength);
875
883 WINPR_ATTR_MALLOC(freerdp_settings_free, 1)
884 WINPR_ATTR_NODISCARD
885 FREERDP_API rdpSettings* freerdp_settings_deserialize(const char* jstr, size_t length);
886
887#ifdef __cplusplus
888}
889#endif
890
893#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:1419
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:2180
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:2014
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:2263
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: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:1431
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:4295
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:1999
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:2388
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:2207
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:2408
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:3689
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:1115
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:2286
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:2246
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:2437
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:2145
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:2297
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:2363
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