Project

General

Profile

Actions

Added in 1.9.0

$var(%var,[N])

Returns the Nth matching variable name.

Searches both local and global variables, wildcards can be used.

See also /var, /set, /unset, /inc, /dec.

Parameters

Parameter Description
%var Variable to match.
[N] If N = 0, number of matched variables (default), otherwise the Nth match. (optional)

Properties

Property Description
.value The variable value.
.local $true if the variable is a local variable, otherwise $false.
.secs Number of seconds until the variable is unset (if autounset is on).
.unset Number of seconds until the variable is unset (if autounset is on).

Examples

; Create a variable.
/set %Example Hello World

; Print number of variables matching '%Example*'.
//echo -ag $var(%Example*, 0)

; Print the name and value from the first match.
//echo -ag $var(%Example*, 1) = $var(%Example*, 1).value

; Delete the variable
/unset %Example

Updated by Per Amundsen over 1 year ago · 8 revisions

Also available in: PDF HTML TXT