Home  /  Autodocs  /  dos.library

NAME

DoShellMethod
Run a method of the shell (V47)

SYNOPSIS

ptr = DoShellMethodTagList(method, tags)
D0 D0 A0

APTR DoShellMethodTagList(ULONG, struct TagItem *)

ptr = DoShellMethod(method, Tag1, ...)

APTR DoShellMethod(ULONG, ULONG, ...)

FUNCTION

Request and run a function of a V47 extended shell. The method ID specifies which feature of the shell is to be run and the tags provide arguments to the method. The return code is either a pointer, or an integer cast to a pointer.

If the current Process is not run from a shell, or the shell is not extended, the function returns NULL and ERROR_OBJECT_WRONG_TYPE in IoErr().

The following methods are implemented by the V47 ROM shell, see also <dos/shell.h>:

SHELL_METH_METHODS
Returns a pointer to a NULL terminated list of ULONGs that lists all methods the shell supports.

SHELL_METH_GETHIST
Return a pointer to the command history. The result code is a pointer to a struct MinList whose nodes are of type struct HistoryNode, see <dos/shell.h>. This method does not take any arguments.

SHELL_METH_CLRHIST
Erase the current history. This method does not take any arguments. Returns a boolean success indicator.

SHELL_METH_ADDHIST
Adds a line to the history. The line to be added is provided by the tag SHELL_ADDH_LINE as a NUL-terminated 'C' style string. A terminating '\n' is NOT required. Returns a boolean success indicator.

SHELL_METH_FGETS
Request input from the console, allowing TAB expansion of the arguments. This method returns a pointer to a NUL- terminated 'C' string. The memory of the string is handled by the shell and MUST NOT be released by the caller. It is valid until the next DoShellMethod() function or until the application terminates.

The following tags are accepted:

SHELL_FGETS_FULL
is a boolean tag that is set to TRUE if the requested line is a full command line, and the first argument is a command. The shell will scan the full command line search path for its expansion and may print the regular prompt. If FALSE, only files in the current directory are scanned, and an abbreviated prompt

is printed. This tag defaults to FALSE.

INPUTS

method
Method requested from the shell

tags
Pointer to taglist with additional information

RESULT

ptr
result or NULL.

NOTES

SHELL_FGETS_FULL is used by ReadArgs() if more parameters are required from the caller. If a custom shell supports TAB expansion, it is recommended that such a shell also implements the above method.

SEE ALSO

<dos/shell.h>