MKS Integrity 2007 Integrations Builder Guide

Chapter 3: Using the MKS API
18
You can set connection-based command options for a command runner that are applied to
every command. For more information, see “Managing Users” on page 42.
NOTE Even though not all application commands explicitly allow these connection
settings, they do not cause an error if set for any command.
To create a command runner
You create a command runner from a session.
For the Java API
Create an instance of the CmdRunner class by calling the createCmdRunner() method
from the Session instance.
For the C API
Create an instance of the mksCmdRunner by calling the mksCreateCmdRunner()
function from the mksSession variable.
Running Commands
There are three activities related to running commands using a command runner:
“Specifying a Command” on page 18
“Executing a Command” on page 20
“Reading Responses” on page 20
Specifying a Command
A command specifies the application to interact with and the command name, and can have
any number of options and selections.
Anything that can be specified on a command line can be specified using a Command class or
function.
For details on the options and selections for each command, see the MKS Integrity 2007 CLI
Reference Guide and the MKS Source 2007 CLI Reference Guide. For details on the responses
returned by each command, see “API Certified Commands” on page 53.
To specify a command for the Java API
You can either specify the command with the Command class and related classes or through a
String array.