RemoteDesktopClientSettings.GetRdpProperty method

Article
07/05/2016

[GetRdpProperty is no longer available for use as of Windows 10 and Windows Server 2016 Technical Preview.]

Retrieves a single named RDP property value. If the specified property has not been set, a default value is retrieved.

Syntax

var object = remoteDesktopClientSettings.getRdpProperty(propertyName);

Parameters

propertyName [in]
Type: String

Specifies the name of the property. For a list of allowed property names, see the SetRdpProperty method.

Return value

Type: Object

The value of the specified property.

Examples

The following code example, from the Remote Desktop app container client sample, demonstrates how to use the GetRdpProperty method to set various properties in the RemoteDesktopClient object.

function getConnectionProperty(propertyName) {
    var propertyValue = propertyName + " = ";

    try {
        propertyValue += myClientControlObject.Settings.GetRdpProperty(propertyName);
    } catch (e) {
        propertyValue += "Error while retrieving this property.";
    }

    return propertyValue + "\n";
}

Requirements

Minimum supported client	Windows 8 [Windows Store apps only]
Minimum supported server	Windows Server 2012 [Windows Store apps only]
End of client support	Windows 8.1
End of server support	Windows Server 2012 R2
IDL	RdpAppContainerClient.idl
Type library	MsTscAx.dll
DLL	MsTscAx.dll