3.6.4.3 GetIpConfigSerialized (Opnum 5)

  • Article

The GetIpConfigSerialized method queries the network adapter configuration and returns select information about the adapters.

The server SHOULD support this method even if the server Initialization State is FALSE.

 HRESULT GetIpConfigSerialized(
   [in] BOOLEAN ApplyClusterFilter,
   [out] SAFEARRAY( byte )* Data,
   [out] int* pcbOut
 );

ApplyClusterFilter: A flag that indicates which adapters to return. If FALSE, then all adapters MUST be returned. If TRUE, then all nonfiltered adapters MUST be returned. Adapters that MUST be filtered are cluster adapters (as specified in the ClusterAdapter field of the ADAPTER2 <27> structure), loopback adapters, and tunnel adapters.

Value

Meaning

TRUE

-128 — -1

Return all nonfiltered adapters.

FALSE

0

Return all adapters.

TRUE

1 — 128

Return all nonfiltered adapters.

Data: A buffer that, on success, SHOULD<28> contain a valid ADAPTERLIST2 structure. The client MUST ignore all Guid items in the ADAPTERLIST2 structure except for those Guid items ranging from the first item through the count of 2 multiplied by the value of NumberOfAdapters.

pcbOut: MUST be the size of the Data buffer, in bytes.

Return Values: A signed 32-bit value that indicates return status. If the method returns a negative value, it has failed. Zero or positive values indicate success, with the lower 16 bits in positive nonzero values containing warnings or flags defined in the method implementation. For more information about Win32 error codes and HRESULT values, see [MS-ERREF] sections 2.2 and 2.1.

Return value/code

Description

0x00000000

S_OK

The call was successful.

For any other condition, this method MUST return a value that is not one of the values listed in the preceding table. The client MUST behave in one consistent, identical manner for all values that are not listed in the preceding table.

Exceptions Thrown: No exceptions are thrown beyond those thrown by the underlying RPC protocol [MS-RPCE].

The opnum field value for this method is 5.

When processing this call, the server MUST do the following:

  • Query the network adapter configuration using an implementation-specific method.

  • Filter out adapters as required by the ApplyClusterFilter parameter.

  • Format the data as an ADAPTERLIST2 structure.

Return the following information to the client:

  • Return the adapter data via the Data parameter.

  • Return the size, in bytes, of Data via the pcbOut parameter.