Interface Cio

interface Cio {
    beginCapture(fullPath: string, append?: boolean): void;
    endCapture(): void;
    getLastStdErr(): string;
    getLastStdOut(): string;
}

Index

Methods

beginCapture endCapture getLastStdErr getLastStdOut

Methods

beginCapture

beginCapture(fullPath, append?): void
Start capturing stdout and stderr from the target program (e.g. printf) to specified file.
Parameters
- fullPath: string
  The full path to the file to which stdout and stderr are to be captured
- Optionalappend: boolean
  Whether to append to the file instead of overwriting it (default: false)
Returns void
Remarks
Will create the file if it does not exist. Will throw if the file cannot be opened for writing.

Example
```
// overwrite file if it already exists
session.cio.beginCapture("C:/capturedOutput.txt");
session.cio.beginCapture("C:/capturedOutput.txt", false);

// append to file if it already exists
session.cio.beginCapture("C:/capturedOutput.txt", true);
```

endCapture

endCapture(): void
Stop capturing to the file

Returns void
Remarks
Does nothing if no capture is in progress

Example
```
session.cio.endCapture();
```

getLastStdErr

getLastStdErr(): string
Get the latest buffered standard error text as a string

Returns string
The latest buffered standard error
Example
```
const lastStdErr = session.cio.getLastStdErr();
console.log(`Last standard error: ${lastStdErr}`);
```

getLastStdOut

getLastStdOut(): string
Returns the latest buffered standard output text as a string

Returns string
The latest buffered standard output
Example
```
const lastStdOut = session.cio.getLastStdOut();
console.log(`Last standard output: ${lastStdOut}`);
```