getfindindex.pro

NRAO GBTIDL
Produced by IDL 7.1.1
Developer Documentation

prev file | next file view single page | view frames | update routines

SUMMARY: fields | routine DETAILS: routine

./guide
getfindindex.pro

Last modification date:: Wed Sep 28 13:27:12 2016

getfindindex

function getfindindex(param, [mode=variable], [count=variable])

Utility function used by setfind, listfind, and clearfind to translate a parameter name into an index number in the !g.find structure. Additional information on that index is also returned.

Returns: Index values of param. Returns -1 if not found.
Version: $Id$

Parameters

param
in, required
string The parameter to locate in !g.find. minimum-match is allowed here. Case is unimportant. Arrays of parameters are not allowed (-1 will be returned).

Keywords

mode
out, optional
variable The mode that this is appropriate for. -1 is all modes, 0 is line and 1 is continuum.

count
out, optional
variable The number of matches to param found in !g.find.

Produced by IDLdoc 1.6 on Wed Sep 28 13:27:18 2016

Parameters
param in, required string	The parameter to locate in !g.find. minimum-match is allowed here. Case is unimportant. Arrays of parameters are not allowed (-1 will be returned).

Keywords
mode out, optional variable	The mode that this is appropriate for. -1 is all modes, 0 is line and 1 is continuum.
count out, optional variable	The number of matches to param found in !g.find.