Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.edit.verifiers.comm.bridge
Class SSTRECVARStruct

java.lang.Object
  extended by com.ibm.etools.iseries.edit.verifiers.comm.bridge.SSTRECVARStruct

public class SSTRECVARStruct
extends Object

Java class to emulate the SSTRECVAR C struct for the CODE communications bridge. The C struct is defined in evfcsys.h as following: typedef struct { // Character data block (output) CHAR cSubValue; // Substitution values encountered CHAR cWeight; // Weighting of returned SST // The following charcater arrays are not ASCIIZ terminated. // Instead, they are blank padded to the right of the value. CHAR chRetTable[10]; // Return Table - 10 characters CHAR chRTLibName[10]; // RT Library name - 10 characters CHAR chJSSTableName[10]; // JOB SSTable name - 10 characters CHAR chJSSTLibName[10]; // JOB SST Lib name - 10 characters CHAR chJobLangID[3]; // JOB Language ID - 3 characters CHAR chJobCountryID[2]; // JOB Country ID - 2 characters CHAR chRSSTdata[256]; // Return SST - 256 characters } CHARDBOUT; typedef union { // For mapping SSTRECVAR buffer (AdeRSST() API output) struct { // Message from QLGRTVSS API call if in error CHAR chMsgID[7]; // Message ID - 7 characters CHAR szMsgText[1]; // Message text start } Message; // The message is ASCIIZ terminated // or struct { // This is the output structure for AdeRSST() API // This structure derived from QLGRTVSS API (output) LONG lBytesAvail; // Bytes available LONG lBytesRet; // Bytes returned LONG lJobCCSID; // Job CCSID value LONG lRetTabCCSID; // Returned table's CCSID CHARDBOUT DataOut; // Character data block } RecData; // Received varible data } SSTRECVAR;


Field Summary
static String Copyright
           
 
Constructor Summary
SSTRECVARStruct(IISeriesSortSequenceTable table)
          Constructor for SSTRECVARStruct.
 
Method Summary
protected  void write(JavaToCOutputStream out)
           
protected static void writeMessage(JavaToCOutputStream out, String msgID, String msg)
          Write the message structure from the SSTRECVAR structure union instead of the RecData structure.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

Copyright

public static final String Copyright
See Also:
Constant Field Values
Constructor Detail

SSTRECVARStruct

public SSTRECVARStruct(IISeriesSortSequenceTable table)
Constructor for SSTRECVARStruct.

Method Detail

write

protected void write(JavaToCOutputStream out)
              throws IOException
Throws:
IOException

writeMessage

protected static void writeMessage(JavaToCOutputStream out,
                                   String msgID,
                                   String msg)
                            throws IOException
Write the message structure from the SSTRECVAR structure union instead of the RecData structure. Format: struct { // Message from QLGRTVSS API call if in error CHAR chMsgID[7]; // Message ID - 7 characters CHAR szMsgText[1]; // Message text start } Message; // The message is ASCIIZ terminated

Throws:
IOException

Rational Developer for Power Systems Software
V7.6

Copyright 2011 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.