High-Level API
This chapter provides the arguments to set high-level APIs and the list of high-level APIs that are used in IxOS setup.
Arguments to the high-level APIs are passed in one of the following ways:
- By value: Denoted by (By value) in the description. By value arguments are either a constant or a $variable reference. For example,{{1 1 1} {1 2 1}} -or- $portList
- By reference: Denoted by (By reference) in the description. By reference arguments must be references to variables, without the `$'. For example, pl after set pl {{1 1 1} [1 1 2}}.
Almost all commands return a value of 0 on successful operation. This can be symbolically referred to as $TCL_OK in a global context or $TCL_OK otherwise. In the examples in this section, a value of 0 is used.
Similarly predefined quantities such as one2oneArray are defined in the global context. If your program is running in other than the global context then it is necessary to include a double colon () before the constant or variable name. For example, one2oneArray.