Home / Autodocs / workbench.library
NAME
- Workbench2CLI
-
Add CLI information to current process. (V48)
SYNOPSIS
status = Workbench2CLI(defaultStack)
D0 D0
BOOL Workbench2CLI(ULONG);
D0 D0
BOOL Workbench2CLI(ULONG);
FUNCTION
This function will take a process started by method other than CLI (such as via Workbench) and change it into a CLI-like application. This will include a path as copied from the Workbench. The CLI default stack is used to pick the stack size for the processes run as CLIs. This is in SYNC mode.
You pass in the default stack that you would like and the rest of the requirements come from the interrogated Workbench task if it is open. If the Workbench has not yet been opened, this routine will return FALSE.
You pass in the default stack that you would like and the rest of the requirements come from the interrogated Workbench task if it is open. If the Workbench has not yet been opened, this routine will return FALSE.
NOTES
If you call Workbench2CLI() and are already a CLI, it will return as if it worked even though it did nothing. (After all, you were a CLI) For this reason, you do not need to check if you are a CLI started program before you call the function.
One word of interest: Once you call this function, the pr_CLI field of your process will *NOT* be NULL. This is by definition of what this program is trying to do, which is make you like a CLI.
You are, however, responsible for setting up any input or output file handles that you may needed. Being workbench started means that you have no standard-in or standard-out. (Just as before) (In other words, this function does not magically give you any I/O as you may already have done so or need a special form of it) These handles are pr_CIS, pr_COS, etc. For example, many DOS calls may rely on these being valid. RunCommand() is one such creature.
One word of interest: Once you call this function, the pr_CLI field of your process will *NOT* be NULL. This is by definition of what this program is trying to do, which is make you like a CLI.
You are, however, responsible for setting up any input or output file handles that you may needed. Being workbench started means that you have no standard-in or standard-out. (Just as before) (In other words, this function does not magically give you any I/O as you may already have done so or need a special form of it) These handles are pr_CIS, pr_COS, etc. For example, many DOS calls may rely on these being valid. RunCommand() is one such creature.
EXAMPLE
void main(int argc, char *argv[])
{
struct Library *WorkbenchBase;
}
{
struct Library *WorkbenchBase;
/* We need V48 to do this */
if(WorkbenchBase=OpenLibrary("workbench.library",48L))
{
}
if(WorkbenchBase=OpenLibrary("workbench.library",48L))
{
/* Cute trick: If you are a CLI, Workbench2CLI is a NO-OP */
/* Thus, you normally don't need to check */
/* NOTE: Most of the time you will ignore the error */
if(Workbench2CLI(4000))
{
}
else
{
}
/* More stuff */
CloseLibrary(WorkbenchBase);
/* Thus, you normally don't need to check */
/* NOTE: Most of the time you will ignore the error */
if(Workbench2CLI(4000))
{
/* We now are workbench started CLI */
/* (Complete with path */
/* (Complete with path */
else
{
/* We did not become a CLI but we still */
/* can run. Just no path */
/* can run. Just no path */
/* More stuff */
CloseLibrary(WorkbenchBase);
INPUTS
- defaultStack
-
The size of the CLI default stack in bytes. You *SHOULD* supply a value of at least 4000.
RESULT
A magically transformed process that has a CLI structure added.
- status
-
Returns TRUE if it worked. Usually can be ignored as your program will continue to work as if you did not call this function.