IMsRdpClientTransportSettings::GatewayUsageMethod property

Specifies when to use a Remote Desktop Gateway (RD Gateway) server.

This property is read/write.

Syntax

HRESULT put_GatewayUsageMethod(
  [in]  ULONG ulProxyMethod
);

HRESULT get_GatewayUsageMethod(
  [out] ULONG *pulProxyUsageMethod
);

Property value

A ULONG variable that specifies the RD Gateway server usage method. This parameter can be one of the following values.

TSC_PROXY_MODE_NONE_DIRECT (0 (0x0))

Do not use an RD Gateway server. In the Remote Desktop Connection (RDC) client UI, the Bypass RD Gateway server for local addresses check box is cleared.

TSC_PROXY_MODE_DIRECT (1 (0x1))

Always use an RD Gateway server. In the RDC client UI, the Bypass RD Gateway server for local addresses check box is cleared.

TSC_PROXY_MODE_DETECT (2 (0x2))

Use an RD Gateway server if a direct connection cannot be made to the RD Session Host server. In the RDC client UI, the Bypass RD Gateway server for local addresses check box is selected.

TSC_PROXY_MODE_DEFAULT (3 (0x3))

Use the default RD Gateway server settings.

TSC_PROXY_MODE_NONE_DETECT (4 (0x4))

Do not use an RD Gateway server. In the RDC client UI, the Bypass RD Gateway server for local addresses check box is selected.

Error codes

Returns S_OK if successful.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Type library	MsTscAx.dll
DLL	MsTscAx.dll
IID	IID_IMsRdpClientTransportSettings is defined as 720298C0-A099-46f5-9F82-96921BAE4701

See also

IMsRdpClientTransportSettings