FreeRDP
include/freerdp/client/cmdline.h File Reference
#include <winpr/cmdline.h>
#include <freerdp/api.h>
#include <freerdp/types.h>
#include <freerdp/settings.h>
This graph shows which files directly or indirectly include this file:

Functions

FREERDP_API int freerdp_client_settings_parse_command_line_arguments (rdpSettings *settings, int argc, char **argv, BOOL allowUnknown)
 parses command line arguments to appropriate settings values. More...
 
FREERDP_API int freerdp_client_settings_parse_command_line_arguments_ex (rdpSettings *settings, int argc, char **argv, BOOL allowUnknown, COMMAND_LINE_ARGUMENT_A *args, size_t count, int(*handle_option)(const COMMAND_LINE_ARGUMENT *arg, void *custom), void *handle_userdata)
 parses command line arguments to appropriate settings values. Additionally allows supplying custom command line arguments and a handler function. More...
 
FREERDP_API int freerdp_client_settings_command_line_status_print (rdpSettings *settings, int status, int argc, char **argv)
 
FREERDP_API int freerdp_client_settings_command_line_status_print_ex (rdpSettings *settings, int status, int argc, char **argv, const COMMAND_LINE_ARGUMENT_A *custom)
 
FREERDP_API BOOL freerdp_client_load_addins (rdpChannels *channels, rdpSettings *settings)
 
FREERDP_API void freerdp_client_warn_unmaintained (int argc, char *argv[])
 
FREERDP_API void freerdp_client_warn_experimental (int argc, char *argv[])
 
FREERDP_API void freerdp_client_warn_deprecated (int argc, char *argv[])
 
FREERDP_API BOOL freerdp_client_print_version (void)
 
FREERDP_API BOOL freerdp_client_print_buildconfig (void)
 
FREERDP_API BOOL freerdp_client_print_command_line_help (int argc, char **argv)
 
FREERDP_API BOOL freerdp_client_print_command_line_help_ex (int argc, char **argv, const COMMAND_LINE_ARGUMENT_A *custom)
 
FREERDP_API BOOL freerdp_parse_username (const char *username, char **user, char **domain)
 
FREERDP_API BOOL freerdp_parse_hostname (const char *hostname, char **host, int *port)
 
FREERDP_API BOOL freerdp_set_connection_type (rdpSettings *settings, UINT32 type)
 
FREERDP_API BOOL freerdp_client_add_device_channel (rdpSettings *settings, size_t count, const char **params)
 
FREERDP_API BOOL freerdp_client_add_static_channel (rdpSettings *settings, size_t count, const char **params)
 
FREERDP_API BOOL freerdp_client_del_static_channel (rdpSettings *settings, const char *name)
 
FREERDP_API BOOL freerdp_client_add_dynamic_channel (rdpSettings *settings, size_t count, const char **params)
 
FREERDP_API BOOL freerdp_client_del_dynamic_channel (rdpSettings *settings, const char *name)
 

Function Documentation

◆ freerdp_client_add_device_channel()

FREERDP_API BOOL freerdp_client_add_device_channel ( rdpSettings *  settings,
size_t  count,
const char **  params 
)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_client_add_dynamic_channel()

FREERDP_API BOOL freerdp_client_add_dynamic_channel ( rdpSettings *  settings,
size_t  count,
const char **  params 
)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_client_add_static_channel()

FREERDP_API BOOL freerdp_client_add_static_channel ( rdpSettings *  settings,
size_t  count,
const char **  params 
)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_client_del_dynamic_channel()

FREERDP_API BOOL freerdp_client_del_dynamic_channel ( rdpSettings *  settings,
const char *  name 
)
Here is the call graph for this function:

◆ freerdp_client_del_static_channel()

FREERDP_API BOOL freerdp_client_del_static_channel ( rdpSettings *  settings,
const char *  name 
)
Here is the call graph for this function:

◆ freerdp_client_load_addins()

FREERDP_API BOOL freerdp_client_load_addins ( rdpChannels *  channels,
rdpSettings *  settings 
)

Step 1: first load dynamic channels according to the settings

step 2: do various adjustements in the settings, to handle channels and settings dependencies

Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_client_print_buildconfig()

FREERDP_API BOOL freerdp_client_print_buildconfig ( void  )
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_client_print_command_line_help()

FREERDP_API BOOL freerdp_client_print_command_line_help ( int  argc,
char **  argv 
)
Here is the call graph for this function:

◆ freerdp_client_print_command_line_help_ex()

FREERDP_API BOOL freerdp_client_print_command_line_help_ex ( int  argc,
char **  argv,
const COMMAND_LINE_ARGUMENT_A custom 
)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_client_print_version()

FREERDP_API BOOL freerdp_client_print_version ( void  )
Here is the caller graph for this function:

◆ freerdp_client_settings_command_line_status_print()

FREERDP_API int freerdp_client_settings_command_line_status_print ( rdpSettings *  settings,
int  status,
int  argc,
char **  argv 
)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_client_settings_command_line_status_print_ex()

FREERDP_API int freerdp_client_settings_command_line_status_print_ex ( rdpSettings *  settings,
int  status,
int  argc,
char **  argv,
const COMMAND_LINE_ARGUMENT_A custom 
)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_client_settings_parse_command_line_arguments()

FREERDP_API int freerdp_client_settings_parse_command_line_arguments ( rdpSettings *  settings,
int  argc,
char **  argv,
BOOL  allowUnknown 
)

parses command line arguments to appropriate settings values.

FreeRDP: A Remote Desktop Protocol Implementation FreeRDP Client Command-Line Interface

Copyright 2012 Marc-Andre Moreau marca.nosp@m.ndre.nosp@m..more.nosp@m.au@g.nosp@m.mail..nosp@m.com

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Parameters
settingsThe settings instance to store the parsed values to
argcthe number of argv values
argvan array of strings (char pointer)
allowUnknownAllow unknown command line arguments or FALSE if not.
Returns
0 in case of success, a negative number in case of failure.

◆ freerdp_client_settings_parse_command_line_arguments_ex()

FREERDP_API int freerdp_client_settings_parse_command_line_arguments_ex ( rdpSettings *  settings,
int  argc,
char **  argv,
BOOL  allowUnknown,
COMMAND_LINE_ARGUMENT_A args,
size_t  count,
int(*)(const COMMAND_LINE_ARGUMENT *arg, void *custom)  handle_option,
void *  handle_userdata 
)

parses command line arguments to appropriate settings values. Additionally allows supplying custom command line arguments and a handler function.

Parameters
settingsThe settings instance to store the parsed values to
argcthe number of argv values
argvan array of strings (char pointer)
allowUnknownAllow unknown command line arguments or FALSE if not.
argsPointer to the custom arguments
countThe number of custom arguments
handle_optionthe handler function for custom arguments.
handle_userdatacustom data supplied to handle_option as context
Returns
0 in case of success, a negative number in case of failure.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_client_warn_deprecated()

FREERDP_API void freerdp_client_warn_deprecated ( int  argc,
char *  argv[] 
)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_client_warn_experimental()

FREERDP_API void freerdp_client_warn_experimental ( int  argc,
char *  argv[] 
)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_client_warn_unmaintained()

FREERDP_API void freerdp_client_warn_unmaintained ( int  argc,
char *  argv[] 
)
Here is the call graph for this function:

◆ freerdp_parse_hostname()

FREERDP_API BOOL freerdp_parse_hostname ( const char *  hostname,
char **  host,
int *  port 
)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_parse_username()

FREERDP_API BOOL freerdp_parse_username ( const char *  username,
char **  user,
char **  domain 
)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_set_connection_type()

FREERDP_API BOOL freerdp_set_connection_type ( rdpSettings *  settings,
UINT32  type 
)
Here is the call graph for this function:
Here is the caller graph for this function: