| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
Shell.PeekOutputText
Peeks into output buffer.
| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
| Shell | 7.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No |
MBS( "Shell.PeekOutputText"; ShellRef { ; Encoding } ) More
Parameters
| Parameter | Description | Example | Flags |
|---|---|---|---|
| ShellRef | The reference number from the shell. | $shell | |
| Encoding | The text encoding for result. Possible encoding names: ANSI, ISO-8859-1, Latin1, Mac, Native, UTF-8, DOS, Hex, Base64 or Windows. More listed in the FAQ. |
UTF8 | Optional |
Result
Returns text or error.
Description
Peeks into output buffer.Returns data in buffer without removing it.
You need to call Shell.ReadOutputText later to actually read the data and remove it from the buffer.
The plugin internally queries Shell.AvailableBytesOutput to see how much to read and return.
See also
This function checks for a license.
Created 11st November 2017, last changed 22nd April 2021
