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

TmuxOptions.SetAsync

Namespace LibTmux

Sets an option in this scope from a value of its key's type.

View as Markdown

Source and package

Module: LibTmux
Declared in: TmuxOptions
Package: LibTmux
Source: src/LibTmux/Options/TmuxOptions.cs

SetAsync ( key : TmuxOptionKey<T> , value : T , cancellationToken : CancellationToken ) → Task ( request : SetOptionRequest , cancellationToken : CancellationToken ) → Task<TmuxOptionValue> methodoverload2 overloads [source] ¶

Parameters

key ( TmuxOptionKey<T> ) – The option and how to write it. (for SetAsync(key, value, cancellationToken))
value ( T ) – The value to set. (for SetAsync(key, value, cancellationToken))
cancellationToken ( CancellationToken ) – Cancels the tmux command. (for SetAsync(key, value, cancellationToken))
request ( SetOptionRequest ) – Which option to set, to what, and how. (for SetAsync(request, cancellationToken))
cancellationToken ( CancellationToken ) – Cancels the tmux commands. (for SetAsync(request, cancellationToken))

Returns

A task that completes when tmux has set the option. (for SetAsync(key, value, cancellationToken))

The value tmux holds afterwards. (for SetAsync(request, cancellationToken))

Raises

TmuxOptionException – tmux rejected the name or the value. (for SetAsync(key, value, cancellationToken))
TmuxOptionException – tmux rejected the option or its value. (for SetAsync(request, cancellationToken))

Discussed in Options and hooks