Skip to main content

CsrWave

CsrWave (cursorName [, graphNameStr [, wantTraceName ]])

The CsrWave function returns a string containing the name of the wave the specified cursor (A through J) is on in the top (or named) graph. If the optional wantTraceName is nonzero, the trace name is returned. A trace name is the wave name with optional instance notation (see ModifyGraph for Traces).

Details

The name of a wave by itself is not sufficient to identify the wave because it does not tell Igor what data folder contains the wave. Thus, if you are calling CsrWave for the purpose of passing the wave name to other Igor procedures, you should use the CsrWaveRef function instead. Use CsrWave if you want the name of the wave to use in an annotation or a notebook.

Examples

String waveCursorAIsOn = CsrWave(A)             // not CsrWave("A")
String waveCursorBIsOn = CsrWave(B,"Graph0") // in specified graph
String traceCursorBIsOn = CsrWave(B,"",1) // trace name in top graph

See Also

Programming With Cursors

Trace Names, Programming With Trace Names