SetGateways Method of the Win32_NetworkAdapterConfiguration Class (Windows)

SetGateways Method of the Win32_Net...

SetGateways Method of the Win32_NetworkAdapterConfiguration Class

The SetGateways WMI class method specifies a list of gateways for routing packets to a subnet that is different from the subnet that the network adapter is connected to. This method only works when the Network Interface Card (NIC) is in the static IP mode.
This topic uses Managed Object Format (MOF) syntax. For more information about using this method, see Calling a Method.

Syntax

MOF

uint32 SetGateways(
  [in]  string DefaultIPGateway[],
  [in]  uint16 GatewayCostMetric[]
);

Parameters

DefaultIPGateway [in]: List of IP addresses to gateways where network packets are routed.
GatewayCostMetric [in]: Assigns a value that ranges from 1 to 9999, which is used to calculate the fastest and most reliable routes. The values of this parameter correspond with the values in the DefaultIPGateway parameter. The default value for a gateway is 1. This optional parameter is new for Windows 2000.

Return Value

Returns a value of 0 (zero) for a successful completion when a reboot is not required, 1 (one) for a successful completion when a reboot is required, and any other value if there is an error.

Return code	Description
0	Successful completion, no reboot required.
1	Successful completion, reboot required.
64	Method not supported when the NIC is in DHCP mode.
65	Unknown failure.
66	Invalid subnet mask.
67	An error occurred while processing an instance that was returned.
68	Invalid input parameter.
69	More than five gateways specified.
70	Invalid IP address.
71	Invalid gateway IP address.
72	An error occurred while accessing the registry for the requested information.
73	Invalid domain name.
74	Invalid host name.
75	No primary or secondary WINS server defined.
76	Invalid file.
77	Invalid system path.
78	File copy failed.
79	Invalid security parameter.
80	Unable to configure TCP/IP service.
81	Unable to configure DHCP service.
82	Unable to renew DHCP lease.
83	Unable to release DHCP lease.
84	IP not enabled on adapter.
85	IPX not enabled on adapter.
86	Frame or network number bounds error.
87	Invalid frame type.
88	Invalid network number.
89	Duplicate network number.
90	Parameter out of bounds.
91	Access denied.
92	Out of memory.
93	Already exists.
94	Path, file, or object not found.
95	Unable to notify service.
96	Unable to notify DNS service.
97	Interface not configurable.
98	Not all DHCP leases can be released or renewed.
100	DHCP not enabled on adapter.

Examples

For script code examples, see WMI Tasks for Scripts and Applications and the TechNet ScriptCenter Script Repository.

For C++ code examples, see WMI C++ Application Examples.

Requirements

Minimum supported client	Windows 2000 Professional
Minimum supported server	Windows 2000 Server
MOF	Cimwin32.mof
DLL	Cimwin32.dll
Namespace	\root\cimv2

Syntax

Parameters

Return Value

Examples

Requirements

See Also