Core LibraryAPI Reference

Choose documentation 3

latest

Current version

latest
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

C# API

method libtmux-dotnet latest

Pane.ReadOutputSinceAsync

Namespace LibTmux.Pane.ReadOutputSinceAsync LibTmux

Reads what the pane has printed since a position, and where this read finished.

View as Markdown

Source and package
Module
LibTmux
Declared in
Pane
Package
LibTmux
Source
src/LibTmux/Pane.Capture.cs
ReadOutputSinceAsync ( position : PaneOutputPosition? , cancellationToken : CancellationToken ) → Task<PaneOutputSince>
methodasync [source]

Description#

A read captures what is new rather than everything the pane holds, so it costs about the same however long the pane has been printing, until history nears history-limit: a read then captures all of it to find its place. Lines a program rewrote in place, such as a progress bar or a prompt redraw, are reported again when they change. A pane whose program has exited reads as it stands.

Parameters
  • position ( PaneOutputPosition? ) – Where the last read finished, or null to start from what the pane shows now.

  • cancellationToken ( CancellationToken ) – Cancels the tmux commands.

Returns

The new lines and the position to pass next time; a read without a position returns none.

Raises
Esc

Type to search.