FreeRDP
settings_str.c File Reference
#include <freerdp/settings.h>
#include <freerdp/log.h>
#include "../core/settings.h"

Macros

#define TAG   FREERDP_TAG("common.settings")
 

Enumerations

enum  FREERDP_SETTINGS_TYPE {
  FREERDP_SETTINGS_TYPE_BOOL , FREERDP_SETTINGS_TYPE_UINT16 , FREERDP_SETTINGS_TYPE_INT16 , FREERDP_SETTINGS_TYPE_UINT32 ,
  FREERDP_SETTINGS_TYPE_INT32 , FREERDP_SETTINGS_TYPE_UINT64 , FREERDP_SETTINGS_TYPE_INT64 , FREERDP_SETTINGS_TYPE_STRING ,
  FREERDP_SETTINGS_TYPE_POINTER
}
 

Functions

BOOL freerdp_settings_clone_keys (rdpSettings *dst, const rdpSettings *src)
 
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. More...
 
void freerdp_settings_dump (wLog *log, DWORD level, const rdpSettings *settings)
 Dumps the contents of a settings struct to a WLog logger. More...
 
void freerdp_settings_free_keys (rdpSettings *dst, BOOL cleanup)
 
SSIZE_T freerdp_settings_get_key_for_name (const char *value)
 Get a key index for the name string of that key. More...
 
SSIZE_T freerdp_settings_get_type_for_name (const char *value)
 Get a key type for the name string of that key. More...
 
const char * freerdp_settings_get_type_name_for_key (size_t key)
 
const char * freerdp_settings_get_type_name_for_type (SSIZE_T type)
 
SSIZE_T freerdp_settings_get_type_for_key (size_t key)
 Get a key type for the key index. More...
 
const char * freerdp_settings_get_name_for_key (size_t key)
 

Variables

static const struct settings_str_entry settings_map []
 

Macro Definition Documentation

◆ TAG

#define TAG   FREERDP_TAG("common.settings")

Enumeration Type Documentation

◆ FREERDP_SETTINGS_TYPE

Enumerator
FREERDP_SETTINGS_TYPE_BOOL 
FREERDP_SETTINGS_TYPE_UINT16 
FREERDP_SETTINGS_TYPE_INT16 
FREERDP_SETTINGS_TYPE_UINT32 
FREERDP_SETTINGS_TYPE_INT32 
FREERDP_SETTINGS_TYPE_UINT64 
FREERDP_SETTINGS_TYPE_INT64 
FREERDP_SETTINGS_TYPE_STRING 
FREERDP_SETTINGS_TYPE_POINTER 

Function Documentation

◆ freerdp_settings_clone_keys()

BOOL freerdp_settings_clone_keys ( rdpSettings *  dst,
const rdpSettings *  src 
)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_settings_dump()

void freerdp_settings_dump ( wLog *  log,
DWORD  level,
const rdpSettings *  settings 
)

Dumps the contents of a settings struct to a WLog logger.

Parameters
logThe logger to write to, must not be NULL
levelThe WLog level to use for the log entries
settingsA pointer to the settings to dump. May be NULL.
Here is the call graph for this function:

◆ freerdp_settings_free_keys()

void freerdp_settings_free_keys ( rdpSettings *  dst,
BOOL  cleanup 
)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_settings_get_key_for_name()

SSIZE_T freerdp_settings_get_key_for_name ( const char *  value)

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

Parameters
valueA key name string like FreeRDP_ServerMode
Returns
The key index or -1 in case of an error (e.g. name does not exist)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_settings_get_name_for_key()

const char* freerdp_settings_get_name_for_key ( size_t  key)
Here is the caller graph for this function:

◆ freerdp_settings_get_type_for_key()

SSIZE_T freerdp_settings_get_type_for_key ( size_t  key)

Get a key type for the key index.

Parameters
keyThe key index like FreeRDP_ServerMode
Returns
The key type (e.g. FREERDP_SETTINGS_TYPE_BOOL) or -1 in case of an error (e.g. name does not exist)
Here is the caller graph for this function:

◆ freerdp_settings_get_type_for_name()

SSIZE_T freerdp_settings_get_type_for_name ( const char *  value)

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

Parameters
valueA key name string like FreeRDP_ServerMode
Returns
The key type (e.g. FREERDP_SETTINGS_TYPE_BOOL) or -1 in case of an error (e.g. name does not exist)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_settings_get_type_name_for_key()

const char* freerdp_settings_get_type_name_for_key ( size_t  key)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_settings_get_type_name_for_type()

const char* freerdp_settings_get_type_name_for_type ( SSIZE_T  type)
Here is the caller graph for this function:

◆ freerdp_settings_print_diff()

BOOL freerdp_settings_print_diff ( wLog *  log,
DWORD  level,
const rdpSettings *  src,
const rdpSettings *  other 
)

Dumps the difference between two settings structs to a WLog.

Parameters
logThe logger to write to, must not be NULL.
levelThe WLog level to use for the log entries.
srcA pointer to the settings to dump. May be NULL.
otherA pointer to the settings to dump. May be NULL.
Returns
TRUE if not equal, FALSE otherwise
Here is the call graph for this function:
Here is the caller graph for this function:

Variable Documentation

◆ settings_map

const struct settings_str_entry settings_map[]
static