getrdpclientprofileResult Structure Definition

The getrdpclientprofileResult structure defines the return type for getrdpclientprofile API.

Syntax



Members

rc

If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings.

message

If the method succeeds, message is NULL else message contains Error/Warning message.

rdpclientprofileList

List of rdpclientprofiles


rdpclientprofile Structure Definition

The rdpclientprofile structure defines the actual return type values for getrdpclientprofile API.

Syntax



Members

name

The name of the rdp profile

rdpurloverride

This setting determines whether the RDP parameters supplied in the vpn url override those specified in the RDP profile.

redirectclipboard

This setting corresponds to the Clipboard check box on the Local Resources tab under Options in RDC.

redirectdrives

This setting corresponds to the selections for Drives under More on the Local Resources tab under Options in RDC.

redirectprinters

This setting corresponds to the selection in the Printers check box on the Local Resources tab under Options in RDC.

redirectcomports

This setting corresponds to the selections for comports under More on the Local Resources tab under Options in RDC.

redirectpnpdevices

This setting corresponds to the selections for pnpdevices under More on the Local Resources tab under Options in RDC.

keyboardhook

This setting corresponds to the selection in the Keyboard drop-down list on the Local Resources tab under Options in RDC.

audiocapturemode

This setting corresponds to the selections in the Remote audio area on the Local Resources tab under Options in RDC.

videoplaybackmode

This setting determines if Remote Desktop Connection (RDC) will use RDP efficient multimedia streaming for video playback.

multimonitorsupport

Enable/Disable Multiple Monitor Support for Remote Desktop Connection (RDC).

rdpcookievalidity

RDP cookie validity period. RDP cookie validity time is applicable for new connection and also for any re-connection that might happen, mostly due to network disruption or during fail-over.

addusernameinrdpfile

Add username in rdp file.

rdpfilename

RDP file name to be sent to End User

rdphost

Fully-qualified domain name (FQDN) of the RDP Listener.

rdplistener

IP address (or) Fully-qualified domain name(FQDN) of the RDP Listener with the port in the format IP:Port (or) FQDN:Port

rdpcustomparams

Option for RDP custom parameters settings (if any). Custom params needs to be separated by '&'

psk

Pre shared key value

randomizerdpfilename

Will generate unique filename everytime rdp file is downloaded by appending output of time() function in the format _

rdplinkattribute

Citrix Gateway allows the configuration of rdpLinkAttribute parameter which can be used to fetch a list of RDP servers(IP/FQDN) that a user can access, from an Authentication server attribute(Example: LDAP, SAML). Based on the list received, the RDP links will be generated and displayed to the user. Note: The Attribute mentioned in the rdpLinkAttribute should be fetched through corresponding authentication method.

builtin

Indicates that a variable is a built-in (SYSTEM INTERNAL) type.

rdpvalidateclientip

This setting determines whether RDC launch is initiated by the valid client IP

_nextgenapiresource


See Also

getrdpclientprofile