IBM 4J manual Method Description Parameter Return Values, Cdfailure

Page 77

Method

Description

Parameter

Return Values

 

 

 

 

Connect

Provides a connection to the

void or a

CD_SUCCESS or

 

Sterling Connect:Direct server.

pointer to an

CD_FAILURE

 

Connect() with a void parameter

IP address

 

 

and port.

 

 

connects to the hostname and

 

 

 

port specified in the client

 

 

 

configuration file.

 

 

 

 

 

 

DisConnect

Disconnects the current session.

void

CD_SUCCESS or

 

 

 

CD_FAILURE

 

 

 

 

SendCommand

Sends a Sterling Connect:Direct

Pointer to a

CD_SUCCESS or

 

command to the server for

command

CD_FAILURE

 

processing.

text buffer.

 

 

 

 

 

ReceiveResponse

Receives the response from a

void

CD_SUCCESS or

 

previously issued command,

 

CD_FAILURE

 

such as the select statistics

 

 

 

command.

 

 

 

 

 

 

GetResponse

Retrieves the response from the

void

Pointer to a

 

ReceiveResponse call.

 

response buffer.

 

 

 

 

GetResponseLength

Returns the length of the

void

Length of the

 

previously received response

 

response buffer from

 

buffer.

 

the previously

 

 

 

issued call.

 

 

 

 

MoreData

Returns a value indicating if

void

TRUE—If more data

 

outstanding data from the

 

is outstanding.

 

previously issued send

 

FALSE—If no data

 

command call is available. If the

 

 

return value is TRUE, call

 

is outstanding.

 

ReceiveResponse again to

 

 

 

retrieve more data.

 

 

 

 

 

 

GetCommandName

Returns the command name of

void

Pointer to a

 

the previously issued send

 

command name

 

command, such as the submit

 

buffer.

 

command.

 

 

 

 

 

 

GetProcessNumber

Returns the Process number of a

void

Process number of a

 

previously issued submit

 

submit command.

 

command.

 

-1—If no submit

 

 

 

 

 

 

command can be

 

 

 

found.

 

 

 

 

GetProcessCount

Returns the number of Processes

void

Process number of a

 

affected by the last send

 

submit command

 

command that issued a delete,

 

that issued a delete,

 

change, or flush process.

 

change or flush

 

 

 

process.

 

 

 

-1—If no submit

 

 

 

command can be

 

 

 

found.

 

 

 

 

GetCurrentError

Moves the error data pointer to

void

TRUE—If successful

 

the current error in the list.

 

FALSE—If no

 

 

 

current error exists.

 

 

 

 

GetNextError

Moves the error data pointer to

void

TRUE—If successful

 

the next error in the list.

 

FALSE—If no more

 

 

 

 

 

 

errors are found.

 

 

 

 

Chapter 4. Writing Custom Programs 71

Image 77
Contents User Guide Page User Guide Copyright IBM Corporation 1999 Contents Iv Sterling ConnectDirect for Unix User Guide CLI Commands Overview of the Command Line InterfaceStarting the CLI Stopping the CLIOption Description Value Entry Sample CommandCdpnum CLI Job ControlOverview of Sterling ConnectDirect Commands CLI History CommandsCommand Command Abbreviation DescriptionParameter Abbreviation Abbreviations for Common Sterling ConnectDirect CommandsParameter Description Values Submitting a ProcessPname = A?PROD5 Parameter Description Values Id , pswd Username@hostname or user@localhostName nnnnn Name host name nnn.nnn.nnn.nnn orSnodeid field Id ,pswd ,newpswdSpecify retain=initial Following command submits the Process named copyfil Following command submits the Process named payrollChanging Process Parameters Following command submits the Process named copy.cdpParameter Description Value Name generic listNode specification, userid generic list Remote node specification generic listDeleting a Process from the TCQ Number list Removing a Process from the Execution Queue Stopping Sterling ConnectDirect Flush process command has the following optional parametersParameter Description Viewing a Process in the TCQPname Locate the Process to view EX HC HE HI HO HR HS PE Monitoring Process Status in the TCQ Following command displays the specified Process numberAll EX HC HE HI HO HR HS PE Output from the command is displayed in the following table Dest=/path/file name Determining the Outcome of a ProcessRecord id list Caev Capr CAEV, CaprParameter Description Value Parameter Description Value Parameter Description Value Date day , hhmmss ampm Srcf=/path/file nameGenerating a Detailed Output Report for a Process Generating a Summary Report for a Process Running System DiagnosticsSelect Statistics Recid LOG Timepname Pnumber Stepname Ccod Fdbk MsgidCOMM.TRC Smgr Trace smgr pnode tnode=ath3500ry level=2 file=Smgp.trc Overview of the Transmission Control Queue Command DefinitionScheduling Sterling ConnectDirect Activity Scheduling Parameter Queue CommentsProgression of a Process Through the TCQ Execution Queue Status Comment Wait QueueElement Comment Hold Queue Timer QueueHeld for Call indicates that the Process was Creating a Translation Table Introduction to Translation TablesExample-Creating a Translation Table Compiling a Translation Table Using the ndmxlt UtilityExample-Modifying a Model Translation Table Using Translation During File Transfer OperationsAccessing Sterling ConnectDirect Messages Translation Table Error MessagesMessage File Content Diagnostic Number DescriptionMessage File Record Format Following is a sample ndmmsg commandDisplaying Message Text Following are the parameters for the message file recordSterling ConnectDirect for Unix User Guide Following are the parameters for the cdsacomp utility Using the Standalone Batch Compression UtilityLevel-Compression level Memory-The amountNnnnn Source codepage, destinationCodepage Example-Precompress a Text File With Codepage Conversion Example-Precompress a Text FileExample-Precompress a Binary File Example-Decompress a Text FileExamples-csdacomp Command Help Configuration Reports Validate Configuration FilesCfgcheck command has the following arguments Argument DescriptionType the following command at a Unix prompt Generating a Configuration Report on the Base InstallationSterling ConnectDirect Utilities Following example shows an excerpt from a sample report Sterling ConnectDirect Utilities Sterling ConnectDirect for Unix User Guide Introduction to Writing Custom Programs Program using the C++ API callsCompiling Custom Programs Compiler version to use for each platformYou want to create such as apicheck Platform Compile Command++ Function Description Writing Custom C ProgramsNdmerrenth Ndmerror NdmnoerrorNdmapirecvrespc Receiving Responses Using ndmapirecvresp or ndmapirecvrespcNdmapirecvresp or Parameter Description Value PNOD-PNODE SNOD-SNODE Following is a sample ndmapirecvresp functionReturn Code Description TruncatedNdmapirecvresp or ndmapirecvrespc to retrieve Ndmapisendcmdc function call has the following return codes Writing Custom C++ ProgramsFollowing is a sample ndmapisendcmd function Selectstatistics or Selectprocess , the CLISterling ConnectDirect for Unix User Guide Cdfailure Method Description Parameter Return ValuesCdsuccess = 0, Cdfailure = Following is the ConnectDirectSession class headerWriting Custom Programs Sterling ConnectDirect for Unix User Guide User Exit Functions User Exit ProgramsProgram Description Chown root exitskeletonReturn Code Goodrc ErrorrcExitprogram Waiting for a Message Using recvexitmsg or recvexitmsgcHeader Following are the parameters for sendexitmsg or sendexitmsgcFile Open Exit Messages Overview of User Exit MessagesStatistics Exit Message Fileopenoutputreplymsg Security Exit MessagesValidatemsg Validatereplymsg GeneratemsgExit Log Files User Exit Stop MessageCopy Control Block 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