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

Macros

#define RDP_FILE_FLAG_PARSE_INT_RELAXED   1
 

Typedefs

typedef BOOL(* rdp_file_fkt_parse) (void *context, const char *key, char type, const char *value)
 

Functions

FREERDP_API void freerdp_client_rdp_file_set_callback_context (rdpFile *file, void *context)
 
FREERDP_API BOOL freerdp_client_parse_rdp_file (rdpFile *file, const char *name)
 
FREERDP_API BOOL freerdp_client_parse_rdp_file_ex (rdpFile *file, const char *name, rdp_file_fkt_parse parse)
 
FREERDP_API BOOL freerdp_client_parse_rdp_file_buffer (rdpFile *file, const BYTE *buffer, size_t size)
 
FREERDP_API BOOL freerdp_client_parse_rdp_file_buffer_ex (rdpFile *file, const BYTE *buffer, size_t size, rdp_file_fkt_parse parse)
 
FREERDP_API BOOL freerdp_client_populate_settings_from_rdp_file (const rdpFile *file, rdpSettings *settings)
 
FREERDP_API BOOL freerdp_client_populate_rdp_file_from_settings (rdpFile *file, const rdpSettings *settings)
 
FREERDP_API BOOL freerdp_client_write_rdp_file (const rdpFile *file, const char *name, BOOL unicode)
 
FREERDP_API size_t freerdp_client_write_rdp_file_buffer (const rdpFile *file, char *buffer, size_t size)
 
FREERDP_API int freerdp_client_rdp_file_set_string_option (rdpFile *file, const char *name, const char *value)
 
FREERDP_API const char * freerdp_client_rdp_file_get_string_option (const rdpFile *file, const char *name)
 
FREERDP_API int freerdp_client_rdp_file_set_integer_option (rdpFile *file, const char *name, int value)
 
FREERDP_API int freerdp_client_rdp_file_get_integer_option (const rdpFile *file, const char *name)
 
FREERDP_API void freerdp_client_rdp_file_free (rdpFile *file)
 
FREERDP_API rdpFile * freerdp_client_rdp_file_new (void)
 
FREERDP_API rdpFile * freerdp_client_rdp_file_new_ex (DWORD flags)
 

Macro Definition Documentation

◆ RDP_FILE_FLAG_PARSE_INT_RELAXED

#define RDP_FILE_FLAG_PARSE_INT_RELAXED   1

FreeRDP: A Remote Desktop Protocol Implementation .rdp file

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.

Typedef Documentation

◆ rdp_file_fkt_parse

typedef BOOL(* rdp_file_fkt_parse) (void *context, const char *key, char type, const char *value)

Function Documentation

◆ freerdp_client_parse_rdp_file()

FREERDP_API BOOL freerdp_client_parse_rdp_file ( rdpFile *  file,
const char *  name 
)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_client_parse_rdp_file_buffer()

FREERDP_API BOOL freerdp_client_parse_rdp_file_buffer ( rdpFile *  file,
const BYTE buffer,
size_t  size 
)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_client_parse_rdp_file_buffer_ex()

FREERDP_API BOOL freerdp_client_parse_rdp_file_buffer_ex ( rdpFile *  file,
const BYTE buffer,
size_t  size,
rdp_file_fkt_parse  parse 
)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_client_parse_rdp_file_ex()

FREERDP_API BOOL freerdp_client_parse_rdp_file_ex ( rdpFile *  file,
const char *  name,
rdp_file_fkt_parse  parse 
)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_client_populate_rdp_file_from_settings()

FREERDP_API BOOL freerdp_client_populate_rdp_file_from_settings ( rdpFile *  file,
const rdpSettings *  settings 
)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_client_populate_settings_from_rdp_file()

FREERDP_API BOOL freerdp_client_populate_settings_from_rdp_file ( const rdpFile *  file,
rdpSettings *  settings 
)

Screen Mode Id: http://technet.microsoft.com/en-us/library/ff393692/

This setting corresponds to the selection in the Display configuration slider on the Display tab under Options in RDC.

Values:

1: The remote session will appear in a window. 2: The remote session will appear full screen.

SmartSizingWidth and SmartSizingHeight:

Adding this option to use the DesktopHeight and DesktopWidth as parameters for the SmartSizingWidth and SmartSizingHeight, as there are no options for that in standard RDP files.

Equivalent of doing /smart-sizing:WxH

Authentication Level: http://technet.microsoft.com/en-us/library/ff393709/

This setting corresponds to the selection in the If server authentication fails drop-down list on the Advanced tab under Options in RDC.

Values:

0: If server authentication fails, connect to the computer without warning (Connect and don’t warn me). 1: If server authentication fails, do not establish a connection (Do not connect). 2: If server authentication fails, show a warning and allow me to connect or refuse the connection (Warn me). 3: No authentication requirement is specified.

Devices to redirect: http://technet.microsoft.com/en-us/library/ff393728/

This setting corresponds to the selections for Other supported Plug and Play (PnP) devices under More on the Local Resources tab under Options in RDC.

Values:

'*': Redirect all supported Plug and Play devices.

'DynamicDevices': Redirect any supported Plug and Play devices that are connected later.

The hardware ID for the supported Plug and Play device: Redirect the specified supported Plug and Play device.

Examples: devicestoredirect:s:* devicestoredirect:s:DynamicDevices devicestoredirect:s:USB\VID_04A9&PID_30C1\6&4BD985D&0&2;,DynamicDevices

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

◆ freerdp_client_rdp_file_free()

FREERDP_API void freerdp_client_rdp_file_free ( rdpFile *  file)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_client_rdp_file_get_integer_option()

FREERDP_API int freerdp_client_rdp_file_get_integer_option ( const rdpFile *  file,
const char *  name 
)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_client_rdp_file_get_string_option()

FREERDP_API const char* freerdp_client_rdp_file_get_string_option ( const rdpFile *  file,
const char *  name 
)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_client_rdp_file_new()

FREERDP_API rdpFile* freerdp_client_rdp_file_new ( void  )
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_client_rdp_file_new_ex()

FREERDP_API rdpFile* freerdp_client_rdp_file_new_ex ( DWORD  flags)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_client_rdp_file_set_callback_context()

FREERDP_API void freerdp_client_rdp_file_set_callback_context ( rdpFile *  file,
void *  context 
)

◆ freerdp_client_rdp_file_set_integer_option()

FREERDP_API int freerdp_client_rdp_file_set_integer_option ( rdpFile *  file,
const char *  name,
int  value 
)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_client_rdp_file_set_string_option()

FREERDP_API int freerdp_client_rdp_file_set_string_option ( rdpFile *  file,
const char *  name,
const char *  value 
)

Set a string option to a rdpFile

Parameters
filerdpFile
namename of the option
valuevalue of the option
Returns
0 on success
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_client_write_rdp_file()

FREERDP_API BOOL freerdp_client_write_rdp_file ( const rdpFile *  file,
const char *  name,
BOOL  unicode 
)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ freerdp_client_write_rdp_file_buffer()

FREERDP_API size_t freerdp_client_write_rdp_file_buffer ( const rdpFile *  file,
char *  buffer,
size_t  size 
)
Here is the call graph for this function:
Here is the caller graph for this function: