Auto Light Dark

Core LibraryAPI Reference

Choose documentation 3

latest

Current version

English

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

C# API

method libtmux-dotnet latest

PsmuxPane.CaptureAsync

Namespace LibTmux

Reads this pane's text through the audited capture subset.

View as Markdown

Source and package

Module: LibTmux
Declared in: PsmuxPane
Package: LibTmux
Source: src/LibTmux/Psmux/PsmuxPane.cs

CaptureAsync ( options : PsmuxCaptureOptions? , cancellationToken : CancellationToken ) → Task<IReadOnlyList<string>> method [source] ¶

Description#

Target consistency is best effort. An external process can remove the pane between LibTmux's existence preflight and psmux's capture.

Parameters

options ( PsmuxCaptureOptions? ) – The typed capture range and rendering choices.
cancellationToken ( CancellationToken ) – Cancels the psmux query.

Returns

The captured lines.

Raises

InvalidOperationException – The selected namespace has no live session.
StaleServerGenerationException – The sole session was replaced after this observation was read.
NotSupportedException – The selected namespace contains more than one session.
TmuxObjectNotFoundException – The observed pane is no longer visible during the preflight.
LibTmuxException – The verified client could not complete the query.