terminalContext: Retrieve Information about RStudio Terminals

In rstudioapi: Safely Access the RStudio API

Retrieve Information about RStudio Terminals

Description

Returns information about RStudio terminal instances.

Usage

terminalContext(id)

Arguments

id	The terminal id. The id is obtained from terminalList(), terminalVisible(), terminalCreate(), or terminalExecute().

Value

A list with elements:

handle	the internal handle
caption	caption
title	title set by the shell
working_dir	working directory
shell	shell type
running	is terminal process executing
busy	is terminal running a program
exit_code	process exit code or NULL
connection	websockets or rpc
sequence	creation sequence
lines	lines of text in terminal buffer
cols	columns in terminal
rows	rows in terminal
pid	process id of terminal shell
full_screen	full screen program running

Note

The terminalContext function was added in version 1.1.350 of RStudio.

Examples

## Not run: 
termId <- rstudioapi::terminalCreate("example", show = FALSE)
View(rstudioapi::terminalContext(termId))


## End(Not run)

rstudioapi documentation built on Oct. 23, 2024, 1:07 a.m.