/** * FreeRDP: A Remote Desktop Protocol Implementation * FreeRDP Client Command-Line Interface * * Copyright 2012 Marc-Andre Moreau * * 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. */ #ifndef FREERDP_CLIENT_CMDLINE_H #define FREERDP_CLIENT_CMDLINE_H #include #include #include #include #ifdef __cplusplus extern "C" { #endif typedef enum { FREERDP_SETTINGS_CMD_PARSE_NO_FLAGS = 0x0000u, FREERDP_SETTINGS_CMD_PARSE_SUPPRESS_WARNINGS = 0x0002u } FREERDP_SETTINGS_CMD_PARSE_FLAGS; /** @brief Callback function type definition for command line handling * * @param arg A pointer to the argument to handle * @param custom A pointer to user defined data * * @return \b 0 for success or a \b COMMAND_LINE_ERROR code * * @since version 3.12.0 */ typedef int (*freerdp_command_line_handle_option_t)(const COMMAND_LINE_ARGUMENT_A* arg, void* custom); /** \brief parses command line arguments to appropriate settings values. * * \param settings The settings instance to store the parsed values to * \param argc the number of argv values * \param argv an array of strings (char pointer) * \param allowUnknown Allow unknown command line arguments or \b FALSE if not. * * \return \b 0 in case of success, a negative number in case of failure. */ WINPR_ATTR_NODISCARD FREERDP_API int freerdp_client_settings_parse_command_line_arguments(rdpSettings* settings, int argc, char** argv, BOOL allowUnknown); /** \brief parses command line arguments to appropriate settings values. Additionally allows * supplying custom command line arguments and a handler function. * * \param settings The settings instance to store the parsed values to * \param argc the number of argv values * \param argv an array of strings (char pointer) * \param allowUnknown Allow unknown command line arguments or \b FALSE if not. * \param args Pointer to the custom arguments * \param count The number of custom arguments * \param handle_option the handler function for custom arguments. * \param handle_userdata custom data supplied to \b handle_option as context * * \since version 3.0.0 * * \return \b 0 in case of success, a negative number in case of failure. */ WINPR_ATTR_NODISCARD 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, freerdp_command_line_handle_option_t handle_option, void* handle_userdata); /** \brief parses command line arguments to appropriate settings values. Additionally allows * supplying custom command line arguments and a handler function. * * \param settings The settings instance to store the parsed values to * \param argc the number of argv values * \param argv an array of strings (char pointer) * \param allowUnknown Allow unknown command line arguments or \b FALSE if not. * \param args Pointer to the custom arguments * \param count The number of custom arguments * \param handle_option the handler function for custom arguments. * \param handle_userdata custom data supplied to \b handle_option as context * \param flags Use any of the \ref FREERDP_SETTINGS_CMD_PARSE_FLAGS flags. By default use * FREERDP_SETTINGS_CMD_PARSE_NO_FLAGS to behave like \ref * freerdp_client_settings_parse_command_line_arguments_ex * * \since version 3.26.0 * * \return \b 0 in case of success, a negative number in case of failure. */ WINPR_ATTR_NODISCARD FREERDP_API int freerdp_client_settings_parse_command_line_arguments_with_flags( rdpSettings* settings, int argc, char** argv, BOOL allowUnknown, COMMAND_LINE_ARGUMENT_A* args, size_t count, freerdp_command_line_handle_option_t handle_option, void* handle_userdata, UINT32 flags, ...); WINPR_ATTR_NODISCARD FREERDP_API int freerdp_client_settings_command_line_status_print(rdpSettings* settings, int status, int argc, char** argv); WINPR_ATTR_NODISCARD 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); WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_client_load_addins(rdpChannels* channels, rdpSettings* settings); /** Print a command line warning about the component being unmaintained. * * \since version 3.0.0 */ FREERDP_API void freerdp_client_warn_unmaintained(int argc, char* argv[]); /** Print a command line warning about the component being experimental. * * \since version 3.0.0 */ FREERDP_API void freerdp_client_warn_experimental(int argc, char* argv[]); /** Print a command line warning about the component being deprecated. * * \since version 3.0.0 */ FREERDP_API void freerdp_client_warn_deprecated(int argc, char* argv[]); FREERDP_API BOOL freerdp_client_print_version(void); /** @brief prints the version of the client including the binary name extracted from \b argv * * @param argc the number of command line arguments, must be >= 0 * @param argv the array of command line argument strings * * @return \b TRUE for success * * @since version 3.10.0 */ FREERDP_API BOOL freerdp_client_print_version_ex(int argc, char** argv); FREERDP_API BOOL freerdp_client_print_buildconfig(void); /** @brief prints the buidconfiguration of the client including the binary name extracted from * \b argv * * @param argc the number of command line arguments, must be >= 0 * @param argv the array of command line argument strings * * @return \b TRUE for success * * @since version 3.10.0 */ FREERDP_API BOOL freerdp_client_print_buildconfig_ex(int argc, char** argv); 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); WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_parse_username(const char* username, char** user, char** domain); WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_parse_hostname(const char* hostname, char** host, int* port); WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_set_connection_type(rdpSettings* settings, UINT32 type); WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_client_add_device_channel(rdpSettings* settings, size_t count, const char* const* params); WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_client_add_static_channel(rdpSettings* settings, size_t count, const char* const* params); WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_client_del_static_channel(rdpSettings* settings, const char* name); WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_client_add_dynamic_channel(rdpSettings* settings, size_t count, const char* const* params); WINPR_ATTR_NODISCARD FREERDP_API BOOL freerdp_client_del_dynamic_channel(rdpSettings* settings, const char* name); #ifdef __cplusplus } #endif #endif /* FREERDP_CLIENT_CMDLINE_H */