<<prev file | next file >>    view single page | view frames    summary: fields | routine    details: routine

ToBeReviewed/STRING/

getfile.pro

Read a text file into a string array.

topgetfile

result = getfile(filein, error=error, help=help, quiet=quiet, lines=lines, find=find)

Return value

Parameters

filein        in required

text file name.

Keywords

error       

=err error flag: 0=ok, 1=file not opened, 2=no lines in file.

help       

quiet       

means give no error message.

lines       

=n Number of lines to read (def=all). Much faster if number of lines is known. Automatic for IDL 5.6 or later.

find       

search te file in the all !path directories (use find.pro)

Version history

Version

$Id: getfile.pro 142 2006-07-21 12:47:49Z navarro $

History

R. Sterner, 20 Mar, 1990 R. Sterner, 1999 Apr 14 --- Added LINES=n keyword. R. Sterner, 2003 Aug 29 --- Automatic lines if IDL 5.6+. R. Sterner, 2003 Sep 02 --- Check if file exists first. R. Sterner, 2003 Sep 04 --- Fixed error in number of lines in file. R. Sterner, 2003 Oct 10 --- Fixed error when no lines. R. Sterner, 2004 Jan 27 --- Fixed to work in IDL as old as vers 4.
Produced by IDLdoc 2.0.