IBM 4J manual Following are the parameters for sendexitmsg or sendexitmsgc, Header

Page 84

The send_exit_file() or send_exit_file_c() function calls have the following return codes. Return codes for the function are defined in ndmapi.h.

Header

GOOD_RC

ERROR_RC

Header

The file descriptor was received successfully.

An error occurred and the file descriptor was not sent successfully. Possible causes include: Sterling Connect:Direct terminated, an invalid value used for the exit_flag or fd parameters, or the last message sent was not send_exit_msg.

Sending a Message to Sterling Connect:Direct Using send_exit_msg() or send_exit_msg_c()

The send_exit_msg() or send_exit_msgc() function enables the user exit program to send a message to Sterling Connect:Direct. This function returns control to the caller immediately after the message is queued.

Following is the format of the send_exit_msg() function:

int send_exit_msg int exit_flag int msg_type,

char * send_buf, int send_buf_len

Following are the parameters for send_exit_msg() or send_exit_msg_c():

Parameter

Description

Value

 

 

 

exit_flag

A flag to specify the sender ID. The only valid

EXIT_PROGRAM

 

value a user exit program can use is

 

 

EXIT_PROGRAM.

 

 

 

 

msg_type

A message name. Messages are requests from

Pointer to message

 

Sterling Connect:Direct and the associated response

 

 

from the user exit program.

 

 

 

 

send_buf

A pointer to the memory location of the message to

Pointer to message

 

be sent.

 

 

 

 

send_buf_len

The length in bytes of the message to be sent.

Length of message

 

 

 

Following are the return codes for send_exit_msg() or send_exit_msg_c(). Return codes for the function are defined in ndmapi.h.

Return Code

GOOD_RC

ERROR_RC

Description

The message was sent successfully.

An error occurred and the message was not sent successfully. Possible causes include: Sterling Connect:Direct terminated or an invalid value is used for the exit_flag or msg_type parameters.

78Sterling Connect:Direct for UNIX: User Guide

Image 84
Contents User Guide Page User Guide Copyright IBM Corporation 1999 Contents Iv Sterling ConnectDirect for Unix User Guide Overview of the Command Line Interface CLI CommandsStarting the CLI Stopping the CLISample Command Option Description Value EntryCLI Job Control CdpnumCLI History Commands Overview of Sterling ConnectDirect CommandsCommand 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 copyfilFollowing command submits the Process named copy.cdp Changing Process ParametersParameter Description Value 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 Running System Diagnostics Generating a Summary Report for a ProcessSelect Statistics Recid LOG Timepname Pnumber Stepname Ccod Fdbk MsgidCOMM.TRC Smgr Trace smgr pnode tnode=ath3500ry level=2 file=Smgp.trc Command Definition Overview of the Transmission Control QueueScheduling Sterling ConnectDirect Activity 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 TableTranslation Table Error Messages Accessing Sterling ConnectDirect MessagesMessage File Content Diagnostic Number DescriptionFollowing is a sample ndmmsg command Message File Record FormatDisplaying Message Text Following are the parameters for the message file recordSterling ConnectDirect for Unix User Guide Using the Standalone Batch Compression Utility Following are the parameters for the cdsacomp utilityLevel-Compression level Memory-The amountSource codepage, destination CodepageNnnnn Example-Precompress a Text File Example-Precompress a Text File With Codepage ConversionExample-Precompress a Binary File Example-Decompress a Text FileExamples-csdacomp Command Help Validate Configuration Files Configuration ReportsCfgcheck command has the following arguments 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 Program using the C++ API calls Introduction to Writing Custom ProgramsCompiling 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 Following is a sample ndmapirecvresp function SNOD-SNODEReturn Code Description TruncatedNdmapirecvresp or ndmapirecvrespc to retrieve Writing Custom C++ Programs Ndmapisendcmdc function call has the following return codesFollowing is a sample ndmapisendcmd function 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 User Exit Programs User Exit Functions Program Description 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