IBM 4J manual Following is the ConnectDirectSession class header, Cdsuccess = 0, Cdfailure =

Page 78

Method	Description	Parameter	Return Values

GetPreviousError	Moves the error data pointer to	void	TRUE—If successful
	the previous error in the list.		FALSE—If no
			FALSE—If no
			previous error
			exists.

GetFirstError	Moves the error data pointer to	void	TRUE—If successful
	the first error in the list.		FALSE—If no error
			FALSE—If no error
			is found.

GetLastError	Moves the error data pointer to	void	TRUE—If successful,
	the last error in the list.		otherwise FALSE.

GetMsgID	Retrieves the message of the	void	Return Value:
	current error data block.		Pointer to a message
	You must call one of the		ID if data block is
	You must call one of the		value.
	GetXXXXError methods before
	calling this method in order to
	retrieve the proper results.

GetFeedBackCode	Returns the feedback code of the	void	Feedback code.
	current error data block.

GetReturnCode	Returns the Sterling	void	One of the valid
	Connect:Direct return code.		Sterling
			Connect:Direct
			return code: 1,4,8,16.

GetStatus	Returns the status.	void	Sterling
			Connect:Direct
			status code.

GetSubstitute	Returns the current substitution	void	Pointer to a
	buffer associated with the error.		substitution buffer.

DisplayError	Displays the current error chain	Parameters:	Return Value:
	to an output location.	Pointer to a	Returns the highest
		file I/O	error found in the
		structure.	error chain or -1 on
			error.

Following is the ConnectDirectSession class header:

#include <stdio.h>

//Error enumeration.

typedef enum CDErrorCode

{

CD_SUCCESS = 0, CD_FAILURE = -1

} CDErrorCode;

//<<Interface>> class CDSession

{

public:

//Communication methods...

virtual CDErrorCode Connect(void) = 0;

virtual CDErrorCode Connect(char *IpAddress, char *IpPort) = 0; virtual CDErrorCode DisConnect(void) = 0;

virtual CDErrorCode SendCommand(char *CmdText) = 0; virtual CDErrorCode ReceiveResponse(void) = 0;

72Sterling Connect:Direct for UNIX: User Guide

Image 78

Contents User Guide Page User Guide Copyright IBM Corporation 1999 Contents Iv Sterling ConnectDirect for Unix User Guide Starting the CLI Overview of the Command Line InterfaceCLI Commands Stopping the CLISample Command Option Description Value EntryCLI Job Control CdpnumCommand CLI History CommandsOverview of Sterling ConnectDirect Commands Command Abbreviation DescriptionAbbreviations for Common Sterling ConnectDirect Commands Parameter AbbreviationSubmitting a Process Pname = A?PROD5Parameter Description Values Parameter Description Values Username@hostname or user@localhost Id , pswdName host name nnn.nnn.nnn.nnn or Name nnnnnId ,pswd ,newpswd Snodeid fieldSpecify retain=initial Following command submits the Process named payroll Following command submits the Process named copyfilParameter Description Value Following command submits the Process named copy.cdpChanging Process Parameters Name generic listRemote node specification generic list Node specification, userid generic listDeleting a Process from the TCQ Number list Removing a Process from the Execution Queue Flush process command has the following optional parameters Stopping Sterling ConnectDirectViewing a Process in the TCQ Parameter DescriptionPname Locate the Process to view EX HC HE HI HO HR HS PE Following command displays the specified Process number Monitoring Process Status in the TCQAll EX HC HE HI HO HR HS PE Output from the command is displayed in the following table Determining the Outcome of a Process Dest=/path/file nameCaev Capr CAEV, Capr Record id listParameter Description Value Parameter Description Value Parameter Description Value Srcf=/path/file name Date day , hhmmss ampmGenerating a Detailed Output Report for a Process Select Statistics Running System DiagnosticsGenerating a Summary Report for a Process Recid LOG Timepname Pnumber Stepname Ccod Fdbk MsgidCOMM.TRC Smgr Trace smgr pnode tnode=ath3500ry level=2 file=Smgp.trc Scheduling Sterling ConnectDirect Activity Command DefinitionOverview of the Transmission Control Queue Scheduling Parameter Queue CommentsProgression of a Process Through the TCQ Execution Queue Wait Queue Element CommentStatus Comment Timer Queue Hold QueueHeld for Call indicates that the Process was Introduction to Translation Tables Creating a Translation TableCompiling a Translation Table Using the ndmxlt Utility Example-Creating a Translation TableUsing Translation During File Transfer Operations Example-Modifying a Model Translation TableMessage File Content Translation Table Error MessagesAccessing Sterling ConnectDirect Messages Diagnostic Number DescriptionDisplaying Message Text Following is a sample ndmmsg commandMessage File Record Format Following are the parameters for the message file recordSterling ConnectDirect for Unix User Guide Level-Compression level Using the Standalone Batch Compression UtilityFollowing are the parameters for the cdsacomp utility Memory-The amountSource codepage, destination CodepageNnnnn Example-Precompress a Binary File Example-Precompress a Text FileExample-Precompress a Text File With Codepage Conversion Example-Decompress a Text FileExamples-csdacomp Command Help Cfgcheck command has the following arguments Validate Configuration FilesConfiguration Reports Argument DescriptionGenerating a Configuration Report on the Base Installation Type the following command at a Unix promptSterling ConnectDirect Utilities Following example shows an excerpt from a sample report Sterling ConnectDirect Utilities Sterling ConnectDirect for Unix User Guide Compiling Custom Programs Program using the C++ API callsIntroduction to Writing Custom Programs Compiler version to use for each platformPlatform Compile Command You want to create such as apicheckWriting Custom C Programs ++ Function DescriptionNdmerrenth Ndmnoerror NdmerrorReceiving Responses Using ndmapirecvresp or ndmapirecvrespc Ndmapirecvresp orNdmapirecvrespc Parameter Description Value PNOD-PNODE Return Code Description Following is a sample ndmapirecvresp functionSNOD-SNODE TruncatedNdmapirecvresp or ndmapirecvrespc to retrieve Following is a sample ndmapisendcmd function Writing Custom C++ ProgramsNdmapisendcmdc function call has the following return codes Selectstatistics or Selectprocess , the CLISterling ConnectDirect for Unix User Guide Method Description Parameter Return Values CdfailureFollowing is the ConnectDirectSession class header Cdsuccess = 0, Cdfailure =Writing Custom Programs Sterling ConnectDirect for Unix User Guide Program Description User Exit ProgramsUser Exit Functions Chown root exitskeletonGoodrc Errorrc Return CodeWaiting for a Message Using recvexitmsg or recvexitmsgc ExitprogramFollowing are the parameters for sendexitmsg or sendexitmsgc HeaderOverview of User Exit Messages Statistics Exit MessageFile Open Exit Messages Security Exit Messages FileopenoutputreplymsgGeneratemsg Validatemsg ValidatereplymsgUser Exit Stop Message Copy Control BlockExit Log Files Copyright IBM Corp IBM Corporation J46A/G4 Bailey Avenue San Jose, CA Trademarks Sterling ConnectDirect for Unix User Guide Index Special characters Generatemsg Generatereplymsg Validatemsg Validatereplymsg Page Sterling ConnectDirect for Unix User Guide Page Product Number 5725-C99