Share via

3.1.4.2.82 ApiCloseNetwork (Opnum 82)

  • Article

(Protocol Version 3) The ApiCloseNetwork method instructs the server to free any context information that was created in a previous ApiOpenNetwork method or ApiOpenNetworkEx method call.

The server SHOULD accept an ApiCloseNetwork request if its protocol server state is read-only and 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 ApiCloseNetwork request if the access level associated with the hNetwork context handle is at least "Read" (section 3.1.4).

 error_status_t ApiCloseNetwork(
   [in, out] HNETWORK_RPC *Network
 );

hNetwork: A pointer to an HNETWORK_RPC context handle that was obtained in a previous ApiOpenNetwork method or ApiOpenNetworkEx method call. To indicate success, the server MUST set to NULL the context handle that this parameter points to.

Return Values: The method returns 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 hNetwork parameter does not represent a valid HNETWORK_RPC context handle.

For any other condition, this method returns 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.