Topics   All   MacOS (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Deprecated   Guides   Examples   Videos
New in version: 10.5   11.0   11.1   11.2   11.3   11.4   11.5   12.0   12.1   12.2    Statistic    FMM    Blog  

Shell.PeekErrorText

Peeks into error output buffer.

Component Version macOS Windows Linux Server iOS SDK License
Shell 7.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ❌ No Paid
MBS( "Shell.PeekErrorText"; 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 error output buffer.
Returns data in buffer without removing it.

You need to call Shell.ReadErrorText later to actually read the data and remove it from the buffer.
The plugin internally queries Shell.AvailableBytesError to see how much to read and return.

See also

Release notes

Blog Entries

Created 11st November 2017, last changed 22nd April 2021


Shell.New - Shell.PeekOutputText

Feedback: Report problem or ask question.


Start Chat