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 FREERDP_API BOOL freerdp_settings_print_diff(wLog* log, DWORD level, const rdpSettings* src,
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 WINPR_ATTR_NODISCARD
160 FREERDP_API ADDIN_ARGV* freerdp_addin_argv_new(size_t argc, const char* const argv[]);
161
162 WINPR_ATTR_MALLOC(freerdp_addin_argv_free, 1)
163 WINPR_ATTR_NODISCARD
164 FREERDP_API ADDIN_ARGV* freerdp_addin_argv_clone(const ADDIN_ARGV* args);
165
166 FREERDP_API BOOL freerdp_addin_argv_add_argument(ADDIN_ARGV* args, const char* argument);
167 FREERDP_API BOOL freerdp_addin_argv_add_argument_ex(ADDIN_ARGV* args, const char* argument,
168 size_t len);
169 FREERDP_API BOOL freerdp_addin_argv_del_argument(ADDIN_ARGV* args, const char* argument);
170
171 FREERDP_API int freerdp_addin_set_argument(ADDIN_ARGV* args, const char* argument);
172 FREERDP_API int freerdp_addin_replace_argument(ADDIN_ARGV* args, const char* previous,
173 const char* argument);
174 FREERDP_API int freerdp_addin_set_argument_value(ADDIN_ARGV* args, const char* option,
175 const char* value);
176 FREERDP_API int freerdp_addin_replace_argument_value(ADDIN_ARGV* args, const char* previous,
177 const char* option, const char* value);
178
179 FREERDP_API BOOL freerdp_device_collection_add(rdpSettings* settings, RDPDR_DEVICE* device);
180
191 FREERDP_API BOOL freerdp_device_collection_del(rdpSettings* settings,
192 const RDPDR_DEVICE* device);
193 WINPR_ATTR_NODISCARD
194 FREERDP_API RDPDR_DEVICE* freerdp_device_collection_find(rdpSettings* settings,
195 const char* name);
196 WINPR_ATTR_NODISCARD
197 FREERDP_API RDPDR_DEVICE* freerdp_device_collection_find_type(rdpSettings* settings,
198 UINT32 type);
199
200 FREERDP_API void freerdp_device_free(RDPDR_DEVICE* device);
201
202 WINPR_ATTR_MALLOC(freerdp_device_free, 1)
203 WINPR_ATTR_NODISCARD
204 FREERDP_API RDPDR_DEVICE* freerdp_device_new(UINT32 Type, size_t count,
205 const char* const args[]);
206
207 WINPR_ATTR_MALLOC(freerdp_device_free, 1)
208 WINPR_ATTR_NODISCARD
209 FREERDP_API RDPDR_DEVICE* freerdp_device_clone(const RDPDR_DEVICE* device);
210
211 WINPR_ATTR_NODISCARD
212 FREERDP_API BOOL freerdp_device_equal(const RDPDR_DEVICE* one, const RDPDR_DEVICE* other);
213
214 FREERDP_API void freerdp_device_collection_free(rdpSettings* settings);
215
216 FREERDP_API BOOL freerdp_static_channel_collection_add(rdpSettings* settings,
217 ADDIN_ARGV* channel);
218 FREERDP_API BOOL freerdp_static_channel_collection_del(rdpSettings* settings, const char* name);
219
220 WINPR_ATTR_NODISCARD
221 FREERDP_API ADDIN_ARGV* freerdp_static_channel_collection_find(rdpSettings* settings,
222 const char* name);
223#if defined(WITH_FREERDP_DEPRECATED)
224 WINPR_DEPRECATED(FREERDP_API ADDIN_ARGV* WINPR_ATTR_MALLOC(freerdp_addin_argv_free, 1)
225 WINPR_ATTR_NODISCARD freerdp_static_channel_clone(ADDIN_ARGV* channel));
226#endif
227
228 FREERDP_API void freerdp_static_channel_collection_free(rdpSettings* settings);
229
230 FREERDP_API BOOL freerdp_dynamic_channel_collection_add(rdpSettings* settings,
231 ADDIN_ARGV* channel);
232 FREERDP_API BOOL freerdp_dynamic_channel_collection_del(rdpSettings* settings,
233 const char* name);
234
235 WINPR_ATTR_NODISCARD
236 FREERDP_API ADDIN_ARGV* freerdp_dynamic_channel_collection_find(const rdpSettings* settings,
237 const char* name);
238
239#if defined(WITH_FREERDP_DEPRECATED)
240 WINPR_DEPRECATED(FREERDP_API ADDIN_ARGV* WINPR_ATTR_MALLOC(freerdp_addin_argv_free, 1)
241 WINPR_ATTR_NODISCARD freerdp_dynamic_channel_clone(ADDIN_ARGV* channel));
242#endif
243
244 FREERDP_API void freerdp_dynamic_channel_collection_free(rdpSettings* settings);
245 FREERDP_API void freerdp_capability_buffer_free(rdpSettings* settings);
246
247 WINPR_ATTR_NODISCARD
248 FREERDP_API BOOL freerdp_capability_buffer_copy(rdpSettings* settings, const rdpSettings* src);
249
250 FREERDP_API void freerdp_server_license_issuers_free(rdpSettings* settings);
251
252 WINPR_ATTR_NODISCARD
253 FREERDP_API BOOL freerdp_server_license_issuers_copy(rdpSettings* settings, char** addresses,
254 UINT32 count);
255
256 FREERDP_API void freerdp_target_net_addresses_free(rdpSettings* settings);
257
258 WINPR_ATTR_NODISCARD
259 FREERDP_API BOOL freerdp_target_net_addresses_copy(rdpSettings* settings, char** addresses,
260 UINT32 count);
261
262 FREERDP_API void freerdp_performance_flags_make(rdpSettings* settings);
263 FREERDP_API void freerdp_performance_flags_split(rdpSettings* settings);
264
265 FREERDP_API BOOL freerdp_set_gateway_usage_method(rdpSettings* settings,
266 UINT32 GatewayUsageMethod);
267 FREERDP_API void freerdp_update_gateway_usage_method(rdpSettings* settings,
268 UINT32 GatewayEnabled,
269 UINT32 GatewayBypassLocal);
270
271 /* DEPRECATED:
272 * the functions freerdp_get_param_* and freerdp_set_param_* are deprecated.
273 * use freerdp_settings_get_* and freerdp_settings_set_* as a replacement!
274 */
275#if defined(WITH_FREERDP_DEPRECATED)
276 WINPR_DEPRECATED_VAR("Use freerdp_settings_get_bool instead",
277 WINPR_ATTR_NODISCARD FREERDP_API BOOL
278 freerdp_get_param_bool(const rdpSettings* settings, int id));
279 WINPR_DEPRECATED_VAR("Use freerdp_settings_set_bool instead",
280 FREERDP_API int freerdp_set_param_bool(rdpSettings* settings, int id,
281 BOOL param));
282
283 WINPR_DEPRECATED_VAR("Use freerdp_settings_get_int[16|32] instead",
284 WINPR_ATTR_NODISCARD FREERDP_API int freerdp_get_param_int(
285 const rdpSettings* settings, int id));
286 WINPR_DEPRECATED_VAR("Use freerdp_settings_set_int[16|32] instead",
287 FREERDP_API int freerdp_set_param_int(rdpSettings* settings, int id,
288 int param));
289
290 WINPR_DEPRECATED_VAR("Use freerdp_settings_set_uint32 instead",
291 WINPR_ATTR_NODISCARD FREERDP_API UINT32
292 freerdp_get_param_uint32(const rdpSettings* settings, int id));
293 WINPR_DEPRECATED_VAR("Use freerdp_settings_set_uint32 instead",
294 FREERDP_API int freerdp_set_param_uint32(rdpSettings* settings, int id,
295 UINT32 param));
296
297 WINPR_DEPRECATED_VAR("Use freerdp_settings_get_uint64 instead",
298 WINPR_ATTR_NODISCARD FREERDP_API UINT64
299 freerdp_get_param_uint64(const rdpSettings* settings, int id));
300 WINPR_DEPRECATED_VAR("Use freerdp_settings_set_uint64 instead",
301 FREERDP_API int freerdp_set_param_uint64(rdpSettings* settings, int id,
302 UINT64 param));
303
304 WINPR_DEPRECATED_VAR("Use freerdp_settings_get_string instead",
305 WINPR_ATTR_NODISCARD FREERDP_API char* freerdp_get_param_string(
306 const rdpSettings* settings, int id));
307 WINPR_DEPRECATED_VAR("Use freerdp_settings_set_string instead",
308 FREERDP_API int freerdp_set_param_string(rdpSettings* settings, int id,
309 const char* param));
310#endif
311
321 WINPR_ATTR_NODISCARD
322 FREERDP_API BOOL freerdp_settings_are_valid(const rdpSettings* settings);
323
331 WINPR_ATTR_NODISCARD
332 FREERDP_API BOOL freerdp_settings_get_bool(const rdpSettings* settings,
333 FreeRDP_Settings_Keys_Bool id);
334
343 FREERDP_API BOOL freerdp_settings_set_bool(rdpSettings* settings, FreeRDP_Settings_Keys_Bool id,
344 BOOL param);
345
353 WINPR_ATTR_NODISCARD
354 FREERDP_API INT16 freerdp_settings_get_int16(const rdpSettings* settings,
355 FreeRDP_Settings_Keys_Int16 id);
356
365 FREERDP_API BOOL freerdp_settings_set_int16(rdpSettings* settings,
366 FreeRDP_Settings_Keys_Int16 id, INT16 param);
367
375 WINPR_ATTR_NODISCARD
376 FREERDP_API UINT16 freerdp_settings_get_uint16(const rdpSettings* settings,
377 FreeRDP_Settings_Keys_UInt16 id);
378
387 FREERDP_API BOOL freerdp_settings_set_uint16(rdpSettings* settings,
388 FreeRDP_Settings_Keys_UInt16 id, UINT16 param);
389
397 WINPR_ATTR_NODISCARD
398 FREERDP_API INT32 freerdp_settings_get_int32(const rdpSettings* settings,
399 FreeRDP_Settings_Keys_Int32 id);
400
409 FREERDP_API BOOL freerdp_settings_set_int32(rdpSettings* settings,
410 FreeRDP_Settings_Keys_Int32 id, INT32 param);
411
419 WINPR_ATTR_NODISCARD
420 FREERDP_API UINT32 freerdp_settings_get_uint32(const rdpSettings* settings,
421 FreeRDP_Settings_Keys_UInt32 id);
422
431 FREERDP_API BOOL freerdp_settings_set_uint32(rdpSettings* settings,
432 FreeRDP_Settings_Keys_UInt32 id, UINT32 param);
433
441 WINPR_ATTR_NODISCARD
442 FREERDP_API INT64 freerdp_settings_get_int64(const rdpSettings* settings,
443 FreeRDP_Settings_Keys_Int64 id);
444
453 FREERDP_API BOOL freerdp_settings_set_int64(rdpSettings* settings,
454 FreeRDP_Settings_Keys_Int64 id, INT64 param);
455
463 WINPR_ATTR_NODISCARD
464 FREERDP_API UINT64 freerdp_settings_get_uint64(const rdpSettings* settings,
465 FreeRDP_Settings_Keys_UInt64 id);
466
475 FREERDP_API BOOL freerdp_settings_set_uint64(rdpSettings* settings,
476 FreeRDP_Settings_Keys_UInt64 id, UINT64 param);
477
485 WINPR_ATTR_NODISCARD
486 FREERDP_API const char* freerdp_settings_get_string(const rdpSettings* settings,
487 FreeRDP_Settings_Keys_String id);
488
496 WINPR_ATTR_NODISCARD
497 FREERDP_API char* freerdp_settings_get_string_writable(rdpSettings* settings,
498 FreeRDP_Settings_Keys_String id);
499
509 FREERDP_API BOOL freerdp_settings_set_string_len(rdpSettings* settings,
510 FreeRDP_Settings_Keys_String id,
511 const char* param, size_t len);
512
521 FREERDP_API BOOL freerdp_settings_set_string(rdpSettings* settings,
522 FreeRDP_Settings_Keys_String id,
523 const char* param);
524
536 FREERDP_API BOOL freerdp_settings_append_string(rdpSettings* settings,
537 FreeRDP_Settings_Keys_String id,
538 const char* separator, const char* param);
539
548 FREERDP_API BOOL freerdp_settings_set_string_from_utf16(rdpSettings* settings,
549 FreeRDP_Settings_Keys_String id,
550 const WCHAR* param);
551
561 FREERDP_API BOOL freerdp_settings_set_string_from_utf16N(rdpSettings* settings,
562 FreeRDP_Settings_Keys_String id,
563 const WCHAR* param, size_t length);
571 WINPR_ATTR_MALLOC(free, 1)
572 WINPR_ATTR_NODISCARD
573 FREERDP_API WCHAR* freerdp_settings_get_string_as_utf16(const rdpSettings* settings,
574 FreeRDP_Settings_Keys_String id,
575 size_t* pCharLen);
576
584 WINPR_ATTR_NODISCARD
585 FREERDP_API const void* freerdp_settings_get_pointer(const rdpSettings* settings,
586 FreeRDP_Settings_Keys_Pointer id);
587
595 WINPR_ATTR_NODISCARD
596 FREERDP_API void* freerdp_settings_get_pointer_writable(rdpSettings* settings,
597 FreeRDP_Settings_Keys_Pointer id);
598
607 FREERDP_API BOOL freerdp_settings_set_pointer(rdpSettings* settings,
608 FreeRDP_Settings_Keys_Pointer id,
609 const void* data);
610
619 FREERDP_API BOOL freerdp_settings_set_pointer_len(rdpSettings* settings,
620 FreeRDP_Settings_Keys_Pointer id,
621 const void* data, size_t len);
622
623 WINPR_ATTR_NODISCARD
624 FREERDP_API const void* freerdp_settings_get_pointer_array(const rdpSettings* settings,
625 FreeRDP_Settings_Keys_Pointer id,
626 size_t offset);
627
628 WINPR_ATTR_NODISCARD
629 FREERDP_API void* freerdp_settings_get_pointer_array_writable(const rdpSettings* settings,
630 FreeRDP_Settings_Keys_Pointer id,
631 size_t offset);
632
633 FREERDP_API BOOL freerdp_settings_set_pointer_array(rdpSettings* settings,
634 FreeRDP_Settings_Keys_Pointer id,
635 size_t offset, const void* data);
636
657 FREERDP_API BOOL freerdp_settings_set_value_for_name(rdpSettings* settings, const char* name,
658 const char* value);
659
666 WINPR_ATTR_NODISCARD
667 FREERDP_API SSIZE_T freerdp_settings_get_key_for_name(const char* value);
668
676 WINPR_ATTR_NODISCARD
677 FREERDP_API SSIZE_T freerdp_settings_get_type_for_name(const char* value);
678
686 WINPR_ATTR_NODISCARD
687 FREERDP_API SSIZE_T freerdp_settings_get_type_for_key(SSIZE_T key);
688
694 WINPR_ATTR_NODISCARD
695 FREERDP_API const char* freerdp_settings_get_type_name_for_key(SSIZE_T key);
696
702 WINPR_ATTR_NODISCARD
703 FREERDP_API const char* freerdp_settings_get_type_name_for_type(SSIZE_T type);
704
710 WINPR_ATTR_NODISCARD
711 FREERDP_API const char* freerdp_settings_get_name_for_key(SSIZE_T key);
712
722 WINPR_ATTR_NODISCARD
723 FREERDP_API UINT32 freerdp_settings_get_codecs_flags(const rdpSettings* settings);
724
740 WINPR_ATTR_NODISCARD
741 FREERDP_API BOOL freerdp_settings_update_from_caps(rdpSettings* settings, const BYTE* capsFlags,
742 const BYTE** capsData,
743 const UINT32* capsSizes, UINT32 capsCount,
744 BOOL serverReceivedCaps);
745
755 WINPR_ATTR_NODISCARD
756 FREERDP_API const char* freerdp_settings_get_server_name(const rdpSettings* settings);
757
766 WINPR_ATTR_NODISCARD
767 FREERDP_API const char* freerdp_rail_support_flags_to_string(UINT32 flags, char* buffer,
768 size_t length);
769
777 WINPR_ATTR_NODISCARD
778 FREERDP_API const char* freerdp_rdp_version_string(UINT32 version);
779
786 WINPR_ATTR_NODISCARD
787 FREERDP_API const char* freerdp_rdpdr_dtyp_string(UINT32 type);
788
789 WINPR_ATTR_NODISCARD
790 FREERDP_API const char* freerdp_encryption_level_string(UINT32 EncryptionLevel);
791 WINPR_ATTR_NODISCARD
792 FREERDP_API const char* freerdp_encryption_methods_string(UINT32 EncryptionLevel, char* buffer,
793 size_t size);
794
802 WINPR_ATTR_NODISCARD
803 FREERDP_API const char* freerdp_supported_color_depths_string(UINT16 mask, char* buffer,
804 size_t size);
805
811 WINPR_ATTR_MALLOC(free, 1)
812 WINPR_ATTR_NODISCARD
813 FREERDP_API char* freerdp_settings_get_config_path(void);
814
832 WINPR_ATTR_NODISCARD
833 FREERDP_API BOOL freerdp_settings_set_monitor_def_array_sorted(rdpSettings* settings,
834 const rdpMonitor* monitors,
835 size_t count);
836
846 WINPR_ATTR_MALLOC(free, 1)
847 WINPR_ATTR_NODISCARD
848 FREERDP_API char* freerdp_settings_serialize(const rdpSettings* settings, BOOL pretty,
849 size_t* plength);
850
858 WINPR_ATTR_MALLOC(freerdp_settings_free, 1)
859 WINPR_ATTR_NODISCARD
860 FREERDP_API rdpSettings* freerdp_settings_deserialize(const char* json, size_t length);
861
862#ifdef __cplusplus
863}
864#endif
865
868#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:1430
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.
Definition settings_getters.c:3729
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_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:2191
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:2025
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_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.
Definition common/settings.c:4306
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.
Definition settings_str.c:99
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:1535
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:2274
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:761
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:1442
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_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:2010
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_set_int32
FREERDP_API BOOL freerdp_settings_set_int32(rdpSettings *settings, FreeRDP_Settings_Keys_Int32 id, INT32 param)
Sets a INT32 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:1509
freerdp_settings_free
FREERDP_API void freerdp_settings_free(rdpSettings *settings)
Free a settings struct with all data in it.
Definition core/settings.c:1288
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_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:766
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:2218
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:2419
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:3700
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.
Definition common/settings.c:240
freerdp_set_gateway_usage_method
FREERDP_API BOOL freerdp_set_gateway_usage_method(rdpSettings *settings, UINT32 GatewayUsageMethod)
Definition common/settings.c:1126
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.
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:2297
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.
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.
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:2257
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.
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:2448
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:2156
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.
Definition settings_getters.c:3723
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.
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:2308
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 no...
Definition common/settings.c:2399
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:2374
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.
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_bool
FREERDP_API BOOL freerdp_settings_set_bool(rdpSettings *settings, FreeRDP_Settings_Keys_Bool id, BOOL param)
Sets a BOOL settings value.
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:373
RDPDR_DEVICE
Definition settings_types.h:450
rdpMonitor
Definition settings_types.h:429
rdp_settings
Definition settings_types_private.h:51