Share via

3.1.4.1.68 ApiCloseNode (Opnum 67)

  • Article

(Protocol Version 2) The ApiCloseNode method instructs the server to free any context information that was created in a previous ApiOpenNode method.

The server SHOULD accept an ApiCloseNode 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.

 error_status_t ApiCloseNode(
   [in, out] HNODE_RPC *Node
 );

Node: A pointer to an HNODE_RPC context handle that was obtained in a previous ApiOpenNode method. 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 hNode parameter does not represent a valid HNODE_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.