cwbOBJ_SendTCPSplF

Purpose

Sends a spooled file to be printed on a remote system. This is the iSeries™ server version of the TCP/IP LPR command.

Syntax

 
unsigned int CWB_ENTRY  cwbOBJ_SendTCPSplF(
                               cwbOBJ_ObjHandle   splFHandle,
                               cwbOBJ_ParmHandle  parmListHandle,
                               cwbSV_ErrHandle    errorHandle);

Parameters

cwbOBJ_ObjHandle splFHandle - input

Handle of the spooled file to be sent.

cwbOBJ_ParmHandle parmListHandle - input

Required. A handle of a parameter list object that contains the parameters for sending the spooled file.

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_NO_ERROR

Successful completion.

CWB_NOT_ENOUGH_MEMORY

Insufficient memory.

CWB_INVALID_HANDLE

Handle is not valid.

CWB_INVALID_PARAMETER

Invalid parameter specified.

CWBOBJ_RC_HOST_ERROR

Host error occurred. Text may be in errorHandle.

CWBOBJ_RC_INVALID_TYPE

Handle is not a spooled file handle.

CWBOBJ_KEY_SEPPAGE

Specifies wether or not to print the separator page.

CWBOBJ_KEY_USRDTATFMLIB

Specifies the name of the user data transform library.

CWBOBJ_KEY_USRDTATFM

Specifies the name of the user data transform.

Usage

The equivalent of an iSeries server send TCP/IP spooled file (SNDTCPSPLF) command will be issued against the spooled file. The following parameter key's MUST be set in the parmListHandl object:

• CWBOBJ_KEY_RMTSYSTEM

  Specifies the remote system to which the print request is sent. May be a remote system name or "*INTNETADR".

• CWBOBJ_KEY_RMTPRTQ

  Specifies the name of the destination print queue.

The following parameter key's may be set in the parmListHandle object:

• CWBOBJ_KEY_DELETESPLF

  Specifies whether to delete the spooled file after it has been successfully sent. May be "*NO" or "*YES". "*NO" is the default.

• CWBOBJ_KEY_DESTOPTION

  Specifies a destination-dependant option. These options will be sent to the remote system with the spooled file.

• CWBOBJ_KEY_DESTINATION

  Specifies the type of system to which the spooled file is being sent. When sending to other iSeries systems, this value should be "*AS/400". May also be "*OTHER", "*PSF/2". "*OTHER" is the default.

• CWBOBJ_KEY_INTERNETADDR

  Specifies the internet address of the receiving system.

• CWBOBJ_KEY_MFGTYPE

  Specifies the manufacturer, type and model when transforming print data for SCS to ASCII.

• CWBOBJ_KEY_SCS2ASCII

  Specifies wether the print data is to be transformed for SCS to ASCII. May be "*NO" or "*YES". "*NO" is the default.

• CWBOBJ_KEY_WSCUSTMOBJ

  Specifies the name of the workstation customizing object.

• CWBOBJ_KEY_WSCUSTMOBJL

  Specifies the name of the workstation customizing object library.