Core LibraryunreleasedAPI Reference

Choose documentation 1

latest

Current version

latest
English

Unreleased libtmux_erlang has not been released. Its API may change during development. This site's structure and URLs may change too.

function libtmux-erlang latest

tmux_window_link:get/3

Read a current membership at the explicit session ID and index. The returned native row carries its registered owner and a new observation identity. Returns target_gone if the session or index is absent. This read does not make later actions atomic and does not refresh previously captured links.

Source and package
Qualified name
tmux_window_link:get/3
Declared in
tmux_window_link
Package
libtmux_erlang
Source
apps/libtmux_erlang/src/tmux_window_link.erl
get(Server, SessionId, Index) -spec get(tmux_server:t(), tmux_model:session_id(), index()) -> {ok, tmux_model:window_link()} | {error, map()}.

Description#

Invalid indexes are rejected before I/O:

Examples#

1> tmux_window_link:get(invalid_server, <<"$0">>, -1).
{error,#{code => invalid_option,path => [index]}}

tmux command#

The tmux commands behind get/3.

tmux C API#

The C declarations in tmux that implement these commands.

Guides#

Pages that discuss get/3.

Concepts
Esc

Type to search.

Reference previewOpen reference