IBM 4J manual Receiving Responses Using ndmapirecvresp or ndmapirecvrespc, Ndmapirecvresp or

Page 70

Receiving Responses Using ndmapi_recvresp() or ndmapi_recvresp_c()

Use ndmapi_recvresp() or ndmapi_recvresp_c() to receive responses that are associated with a previous command sent from the application. Following is the format for ndmapi_recvresp() or ndmapi_recvresp_c():

int32	ndmapi_recvresp ERROR_H error int32 * resp_length, char * resp_buffer,
int32	* resp_moreflag

Following are the parameters for ndmapi_recvresp() or ndmapi_recvresp_c():

Parameter	Description	Value

error	A pointer to a Sterling	Pointer
	Connect:Direct-defined structure that
	contains error information or status
	information.

resp_length	A pointer to the length, in bytes, of the	Pointer to number of bytes
	application buffer to receive the	returned or 0 if you no longer
	response. The API sets this parameter to	want to receive responses.
	the number of bytes returned.	Setting this field to zero purges
		all queued responses.

resp_buffer	A pointer to the application buffer that	A local buffer, with a size greater
	receives the command or submit	than or equal to that set by
	response. This buffer should allocate	resp_length and filled in by
	4096 bytes.	ndmapi_recvresp() or
	The format of resp_buffer is a free-form	ndmapi_recvresp_c().
	The format of resp_buffer is a free-form
	text record structure. Field names are	The CLI passes the resp_buffer to
	four characters long and all uppercase.	AWK for parsing. Valid values
	The data can be any length and can	include:
	include blanks. The structure is:	ADMN—Sterling Connect:Direct
		ADMN—Sterling Connect:Direct
	field name=data field name=data ...	administrator name
	For example:	ADPH—Sterling Connect:Direct
	SUBM = username PNUM = 12	administrator phone number
	SUBM = username PNUM = 12
	PNAM = proc1 ...	CCOD—Completion code
		CKPT—Checkpoint
		CLAS—Class
		DBYW—Bytes written
		DBYX—Bytes received
		DCOD—Destination completion
		code
		DDAY—Submit date

64Sterling Connect:Direct for UNIX: User Guide

Image 70

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 AbbreviationPname = A?PROD5 Submitting a ProcessParameter 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 Element Comment Wait QueueStatus 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 amountCodepage Source codepage, destinationNnnnn 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 NdmerrorNdmapirecvresp or Receiving Responses Using ndmapirecvresp or ndmapirecvrespcNdmapirecvrespc 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 HeaderStatistics Exit Message Overview of User Exit MessagesFile Open Exit Messages Security Exit Messages FileopenoutputreplymsgGeneratemsg Validatemsg ValidatereplymsgCopy Control Block User Exit Stop MessageExit 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