3.14.4.1 InitializeAdapterConfiguration (Opnum 3)

The InitializeAdapterConfiguration method initializes the server Firewall State to process subsequent calls of GetNextAdapterFirewallConfiguration.

This method is called at least once before GetNextAdapterFirewallConfiguration.

 HRESULT InitializeAdapterConfiguration(
   [out] unsigned long* cRetAdapters
 );

cRetAdapters: A pointer to an unsigned 32-bit integer indicating the number of adapters in the network adapter index of the Firewall State. Upon successful completion of this method, the server MUST set this value. If the method fails, the client MUST ignore this value.

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.

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

The opnum field value for this method is 3.

When processing this call, the server MUST initialize the Firewall State. The server MUST retain the Firewall State until either the protocol session terminates or this method is called again (in which case the server MUST reinitialize the Firewall State).

The server returns the following information to the client:

  • The output parameters set to the values specified previously.