settings_str.c File Reference

#include "../core/settings.h"
#include "settings_str.h"

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 (SSIZE_T key)
	Returns the type name for a key. More...
const char *	freerdp_settings_get_type_name_for_type (SSIZE_T type)
	Returns the type name for a type. More...
SSIZE_T	freerdp_settings_get_type_for_key (SSIZE_T key)
	Get a key type for the key index. More...
const char *	freerdp_settings_get_name_for_key (SSIZE_T key)
	Returns the type name for a key. More...
BOOL	freerdp_settings_copy_item (rdpSettings *dst, const rdpSettings *src, SSIZE_T id)
	copies one setting identified by id from src to dst More...

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_copy_item()

BOOL freerdp_settings_copy_item	(	rdpSettings *	dst,
		const rdpSettings *	src,
		SSIZE_T	id
	)

copies one setting identified by id from src to dst

The function frees up all allocated data in dst before copying the data from src

Parameters

dst	A pointer for the settings to copy data to. May be NULL (fails copy)
src	A pointer to the settings to copy. May be NULL (fails copy)
id	The settings identifier to copy

Returns

TRUE for success, FALSE for failure.

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

log	The logger to write to, must not be NULL
level	The WLog level to use for the log entries
settings	A 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

value

A 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

(

SSIZE_T

key

)

Returns the type name for a key.

Parameters

key	the key number to stringify

Returns

the name of the key or NULL

Here is the caller graph for this function:

freerdp_settings_get_type_for_key()

SSIZE_T freerdp_settings_get_type_for_key

(

SSIZE_T

key

)

Get a key type for the key index.

Parameters

key	The 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

value

A 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

(

SSIZE_T

key

)

Returns the type name for a key.

Parameters

key	the key number to stringify

Returns

the type name of the key or FREERDP_SETTINGS_TYPE_UNKNOWN

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

)

Returns the type name for a type.

Parameters

type	the type to stringify

Returns

the name of the key or FREERDP_SETTINGS_TYPE_UNKNOWN

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

log	The logger to write to, must not be NULL.
level	The WLog level to use for the log entries.
src	A pointer to the settings to dump. May be NULL.
other	A 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: