GetVarName

Returns the name of the specified variable.

Syntax

GetVarName(doc, varNumber, varType)

Parameters

Parameter

Type

Description

doc

documentReference

Reference to the document.

varNumber

number

1-based variable number within the group specified by varType.

varType

string

Variable type. Should be ‘neuron’, ‘neuronorevent’ , ‘event’, ‘interval’ ‘wave’, ‘popvector’, ‘continuous’, ‘marker’ or ‘all’

Return

Returns the name of the specified variable.

Examples

Python

import nex
doc = nex.GetActiveDocument()
# get the name of the first event variable
name = nex.GetVarName(doc, 1, "event")

NexScript

doc = GetActiveDocument()
% get the name of the first event variable
name = GetVarName(doc, 1, "event")