CALL_OPTIONS Class

The CALL_OPTIONS class represents the options for each called COBOL program. If you want to pass program options to the "cvm.callProgram" method that runs the COBOL program, create a CALL_OPTIONS object, then add options to it. The CALL_OPTIONS class is structured as follows:

class CALL_OPTIONS {
 public String GetOption( String key );
 public void SetOption( String key, String value );
};

Valid call options include:

• cache — an unsigned value that determines whether the runtime should maintain the program in a memory cache after it has been canceled.

  This parameter is useful for application servers like CICS that allow each program to be configured as resident or nonresident.

  If "cache" is FALSE ("0"), the runtime removes the program from memory and sets the Working-Storage to its initial state on subsequent calls.

  If "cache" is TRUE ("1"), it marks the program as "cached" and resets Working-Storage for the next call; the program remains in memory according to the caching rules. For information on managing logical and physical cancels that may affect the behavior of "cache", and see also LOGICAL_CANCELS.

• debug_method (-dn) where n is 0-3:

  0 = ADM_NONE for no debugging

  1 = ADM_XTERM to debug using a new xterm

  2 = ADM_TERMINAL to debug using an existing terminal through runcbl

  3 = ADM_THINCLIENT to debug using a waiting thin client

  Based on the debug_method selected, you may need to also specify debug_method_string.

• debug_method_string — a char* that sets the display setting for the debug_method

  For ADM_XTERM, set to the Xservername:displaynumber of the xterm or set to NULL to allow the xterm to use the default display given by the DISPLAY environment variable. For ADM_TERMINAL, set the string to the tty device on which you will execute runcbl. For ADM_THINCLIENT, set to client:port where the client is the host on which acuthin is executing and port is the port on which it is listening.

  Note: The value of debug_method_string overrides the value, if any, in the DISPLAY configuration variable for the xterm.

  See Background Debugging Options for more information on background debugging.

• no.stop — an unsigned input value that, when set to "1", causes STOP RUN to be ignored.
• program.name — the name of the COBOL program being called

The CALL_OPTIONS class contains a linkage_signature property that describes the data in the linkage section. For example, a linkage_signature of "X45X20SSIJ" describes two PIC X items of 45 and 20 bytes respectively, two shorts, an integer, and a long.

The linkage_signature ensures that there is enough memory for Java strings to get passed in, even when the Java string has a shorter length than the PIC X data item in the linkage section. For example, a Java string of length 10 can be passed into a PIX X(45) data item. In this case, 45 bytes are allocated to memory, not 10 bytes.