Share via

3.1.4.2.115 ApiCloseBatchPort (Opnum 116)

  • Article

(Protocol Version 3) The ApiCloseBatchPort method instructs the server to free any context information that is created in a previous ApiCreateBatchPort method.

The server SHOULD accept an ApiCloseBatchPort 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 ApiCloseBatchPort request if the client's access level is at least "Read" (section 3.1.4).

 error_status_t ApiCloseBatchPort(
   [in, out] HBATCH_PORT_RPC * phBatchPort
 );

phBatchPort: A pointer to an HBATCH_PORT_RPC context handle that was obtained in a previous ApiCreateBatchPort method call. Upon success, the server MUST set to NULL (0x00000000) the context handle pointed to by this parameter.

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 phBatchPort parameter does not represent a valid HBATCH_PORT_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.