cwbOBJ_DropConnections

Use the cwbOBJ_DropConnections API with this product.

Purpose

Drops all unused conversations to all systems for the network print server for this process.

Syntax

 
unsigned int CWB_ENTRY  cwbOBJ_DropConnections(
                               cwbSV_ErrHandle   errorHandle);

Parameters

cwbSV_ErrHandle errorHandle - output: Optional, may be 0. Any returned messages will be written to this object. It is created with the cwbSV_CreateErrHandle() API. The messages may be retrieved through the cwbSV_GetErrText() API. If the parameter is set to zero, no messages will be retrievable.

Return Codes

The following list shows common return values.

CWB_OK: Successful completion.
CWBOBJ_RC_HOST_ERROR: Host error occurred. Text may be in errorHandle.

Usage

The CWBOBJ.DLL maintains a pool of available conversations to the network print server for use on the APIs. These conversations normally time out after not having been used for 10 to 20 minutes and are then dropped. This API allows the application to clean up the pool of conversations immediately without waiting for the timeout. It can also be used at the end of the process to make sure that any conversations are terminated. This API will drop all connections to all servers for this process that are not "in use." In use connections include those with open spooled files on them (for creating or reading from).