Gateways Property of the IFPCAdapter2 Interface

The Gateways property gets a comma-delimited list of all the default gateways configured on the network adapter. Set the Gateways property to an empty string to unset the default gateway on a Network Interface Card (NIC).

[C++]
HRESULT put_Gateways(
	BSTR bstrGateways
);
HRESULT get_Gateways(
	BSTR* pbstrGateways
);

Parameters

pbstrGateways

Pointer to a BSTR that is set on return to a string value specifying a comma-delimited list of all the default gateways configured on the network adapter.

bstrGateways

BSTR that specifies a comma-delimited lisst of all the default gateways configured on the network adapter.

Return Value

These property methods return S_OK if the call is successful; otherwise, they return an error code.

Example Code

Unsets the default gateway on a NIC using the put_Gateways property method.

CComBSTR sbstrEmpty(L"");
ASSERT(!!sbstrEmpty);
HRESULT hr = ipAdapter->put_Gateways(sbstrEmpty);
//...
[Visual Basic]
Property Gateways As String

Property Value

String that specifies a comma-delimited list of all the default gateways configured on the network adapter.

Example Code

Unsets the default gateway on a NIC using the Adapter.Gateways property.

Adapter.Gateways = ""

Remarks

This property is read/write. The default value is an empty string.

Requirements

Client Requires Windows Vista or Windows XP.
Server Requires Windows Server 2008.
Version Requires Forefront Threat Management Gateway (TMG).
IDL

Declared in Msfpccom.idl.

DLL

Requires Msfpccom.dll.

See Also

FPCAdapter


Send comments about this topic to Microsoft

Build date: 11/30/2009

© 2008 Microsoft Corporation. All rights reserved.