IRemoteDesktopClientSettings::GetRdpProperty method

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps | Metro style apps

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

Syntax

HRESULT GetRdpProperty(
  [in]           BSTR propertyName,
  [out, retval]  VARIANT *pValue
);

Parameters

propertyName [in]

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

pValue [out, retval]

The address of a VARIANT variable that receives the property value.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Examples

The following JavaScript code example shows how to use this method to retrieve a named property.

function GetFullAddressProperty(rdpControl)
{
    var fullAddress = rdpControl.Settings.GetRdpProperty("Full Address");

    return fullAddress;
}

Requirements

See also

IRemoteDesktopClientSettings

Send comments about this topic to Microsoft

Build date: 4/21/2012