Share via

3.1.4.2.93 ApiCloseNetInterface (Opnum 93)

  • Article

(Protocol Version 3) The ApiCloseNetInterface method instructs the server to free any context information that was created in a previous ApiOpenNetInterface method.

The server SHOULD accept an ApiCloseNetInterface request if its protocol server state is read-only, and the server MUST accept the request for processing if it is in the read/write state, as specified in section 3.1.1.

The server SHOULD accept an ApiCloseNetInterface request if the access level associated with the hNetInterface context handle is at least "Read" (section 3.1.4).

 error_status_t ApiCloseNetInterface(
   [in, out] HNETINTERFACE_RPC *NetInterface
 );

hNetInterface: A pointer to an HNETINTERFACE_RPC context handle that was obtained in a previous ApiOpenNetInterface method or ApiOpenNetInterfaceEx method call. To indicate success, the server MUST set to NULL the context handle that this parameter points to. Upon failure, the client MUST ignore the context handle that this parameter points to.

Return Values: The method MUST return the following error codes for the specified conditions.

Return value/code

Description

0x00000000

ERROR_SUCCESS

Success.

0x00000006

ERROR_INVALID_HANDLE

The data that is pointed to by the hNetInterface parameter does not represent a valid HNETINTERFACE_RPC context handle.

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.