ToBeReviewed/STRING/
getwrd.pro
Return the n'th word from a text string.
getwrd
String
result = getwrd(TXTSTR, NTH[, MTH], help=help, location=location, delimiter=delimiter, notrim=notrim, last=last, nwords=nwords)
Return value
wrd = returned word or words.
Parameters
TXTSTR
in
required
type: string or array of strings
text string to extract from.
The first element is used if txt is an array.
NTH
in
required
type: integer
default: 0
word number to get (first = 0 = def)
MTH
in
optional
type: integer
optional last word number to get.
Keywords
help
location
= l. Return word n string location.
delimiter
= d. Set word delimiter (def = space & tab).
notrim
suppresses whitespace trimming on ends.
last
means n is offset from last word. So n=0 gives
last word, n=-1 gives next to last, ...
If n=-2 and m=0 then last 3 words are returned.
nwords
= n. Returns number of words in string.
Version history
Version
$Id: getwrd.pro 232 2007-03-20 16:59:36Z pinsard $
History
Ray Sterner, 6 Jan, 1985.
R. Sterner, Fall 1989 --- converted to SUN.
R. Sterner, Jan 1990 --- added delimiter.
R. Sterner, 18 Mar, 1990 --- added /LAST.
R. Sterner, 31 Jan, 1991 --- added /NOTRIM.
R. Sterner, 20 May, 1991 --- Added common and NULL string.
R. Sterner, 13 Dec, 1992 --- Made tabs equivalent to spaces.
R. Sterner, 4 Jan, 1993 --- Added NWORDS keyword.
R. Sterner, 2001 Jan 15 --- Fixed to use first element if not a scalar.
Johns Hopkins University Applied Physics Laboratory.
Copyright (C) 1985, Johns Hopkins University/Applied Physics Laboratory
This software may be used, copied, or redistributed as long as it is not
sold and this copyright notice is reproduced on each copy made. This
routine is provided as is without any express or implied warranties
whatsoever. Other limitations apply as described in the file disclaimer.txt.
Known issues
Restrictions
If a NULL string is given (txt="") then the last string
given is used. This saves finding the words again.
If m > n wrd will be a string of words from word n to
word m. If no m is given wrd will be a single word.
n<0 returns text starting at word abs(n) to string end
If n is out of range then a null string is returned.
See also nwrds.
Other attributes
Uses routines
getwrd_com
Common blocks used
getwrd_com
Produced by IDLdoc 2.0.
