![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
Apex Shell Commands This chapter describes the built-in commands available in Apex Shell. These commands are in addition to the standard cshell commands.
New commands are either Procedures or Functions.
- Procedures
- Functions
- String Functions
- Apex Related Functions
- Apex Component-enabled Functions
- Network-Related Functions
- Other Functions
Procedures
Invokes a new copy of the Apex Shell interpreter on the given arguments within the same process. Sets the status variable.
Stop in the debugger at this statement.
This is a top-level command which is specific to ClearCase. It takes as its arguments the same arguments that would be given in a cleartool command line (without the word cleartool). When invoked as a function, the output from the cleartool command is returned as a string with embedded newlines.
After any clearcase command, the shell variable $clearcase_status will be set to the numeric ClearCase status value.
Create a symbolic link named <source> which refers to <target>. Sets last_error.
Create the directory path given. Sets last_error.
Returns a 2 token string with the integer File_Descriptor numbers of a created pipe. Sets last_error.
editor_to_server <editor_name>
Maps an Editor_Name to its Server_Name.
kill_process [-<signal>] <process_id>
If <signal> is given, it can be an integer or a signal name without the SIG.
kill_group [-<signal>] <process_group_id>
If <signal> is given it can be an integer or a signal name without the SIG.
Declare a variable local to a function. It can only be dereferenced within the function and ceases to exist when the function returns. It can also be used in a main program.
For secondary editor's like Jobs, returns the name of the controlling editor.
return [<value>]
Return a value from a function.
server_to_editor <server_name>
Maps a Server_Name to its main editor.
set_variable <target_var_name> <var_name>
Assign the value of Var_Name to Target_Var_Name.
Show the names of all built-in types.
Sleep the given number of seconds.
Display the interpreter's runtime stack.
Functions
action_location <filename> <action_name>
Returns the line number of the action.
Returns a list of the names of the actions in the given file.
clearcase_error [error_number]
Returns a string image for the indicated ClearCase error number. If error_number is not given, returns the image of the latest ClearCase error.
Pathname of the current file being executed from.
Line number of the statement being executed.
Returns 1, if there is a declared object with the given name.
Returns 1, if the given name is a fully qualified pathname.
Returns 1 if a given user-defined function exists.
function_location <filename> <function_name>
Returns the line number of the function.
Returns list of all defined functions whose name matches the given pattern.
Returns a list of the names of the functions in the given file.
keyword_replace <source> <context>
Perform Apex keyword replacement on <source>. Returns the replaced string. Sets last_error.
Returns the string name of the Apex local directory.
object_filter <name> <pathname_filter>
Returns 1 if the given name matches the given filter string.
Get the indicated parameter, first parameter is 1; an alternative to $1, etc., allowing iteration over all parameters
Returns the process id of the parent process.
Returns 1 if a given process exists.
Return the process group id of the current process (or the given process).
Resolve a script name against the script_path. Returns the full pathname or the original name if it doesn't resolve
Split a colon separated path value into a space separated string of the individual values.
String Functions
Returns a one character string from the given character code.
Returns the index'th character of the string. The first index is 0
Return index of first occurrence of s within t. If start is not given, start = 0
Return index of first occurrence of any char from s in t. If start is not given, start = 0
Returns a string which is a newline.
reverse_locate <s> <t> [<start>]
Like locate starting from end of string and scanning backwards.
reverse_locate_any <s> <t> [<start>]
See locate_any and reverse_locate.
Apply <number> to the <format> string and return the resulting string.
Remove leading and trailing blanks
substring <value> <start> <len>
Returns a string which is a tab
Apex Related Functions
Get the canonical pathname of the given argument.
Returns 1 if name identifies a view.
Returns 1 if name identifies a subsystem.
Get the enclosing subsystem of a filename.
Get the enclosing view of a filename.
Apex Component-enabled Functions
Returns 1 if Apex Ada operations are enabled.
Returns 1 if Apex C/C++ operations are enabled.
Returns 1 if Apex Ada operations are enabled, and C/C++ operations are not.
Returns 1 if Apex C/C++ operations are enabled, and Ada operations are not.
Returns 1 if Summit task operations are enabled.
Network-Related Functions
host_to_machine <host machine number>
Convert host machine number to machine name.
machine_to_host <machine name>
Convert machine name to host machine number.
Convert machine name to IP address (Dotted IP form).
Convert IP address to machine name.
Other Functions
attribute_names
Returns an object of type string_map of session attribute names.
Retrieve an environment variable.
Returns a list of the full pathnames of all Summit tasks in the given domain or the default domain if no argument is given.
Like Get_Task_Names but it returns an object of type string_array with the task pathnames.
Returns the string name of the users's .Rational directory.
Resolves the given arguments like the -task option does.
Returns the string name of the Apex temp directory.
Generate a temp file full pathname; uses temp_dir, if no dir is given.
Rational Software Corporation http://www.rational.com support@rational.com techpubs@rational.com Copyright © 1993-2001, Rational Software Corporation. All rights reserved. |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |