- Timestamp:
- 07/21/06 14:47:49 (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRING/getfile.html
r138 r142 696 696 </div> 697 697 698 <div id="file_comments"></div> 698 <div id="file_comments"> 699 Read a text file into a string array. 700 </div> 699 701 700 702 … … 717 719 718 720 <div class="comments"> 719 NAME: 720 GETFILE 721 PURPOSE: 722 Read a text file into a string array. 723 CATEGORY: 724 CALLING SEQUENCE: 725 s = getfile(f) 726 INPUTS: 727 f = text file name. in 728 KEYWORD PARAMETERS: 729 Keywords: 730 ERROR=err error flag: 0=ok, 1=file not opened, 731 2=no lines in file. 732 /QUIET means give no error message. 733 LINES=n Number of lines to read (def=all). 734 Much faster if number of lines is known. 735 Automatic for IDL 5.6 or later. 736 /FIND search te file in the all !path directories (use 737 find.pro) 738 OUTPUTS: 739 s = string array. out 740 COMMON BLOCKS: 741 NOTES: 742 MODIFICATION HISTORY: 721 </div> 722 723 <h3>Return value</h3><div class="preformat"> 724 </div> 725 726 727 <h3>Parameters</h3> 728 729 730 <h4 id="_getfile_param_filein">filein 731 <span class="attr">in</span> 732 733 734 <span class="attr">required</span> 735 736 737 738 739 </h4> 740 741 <div class="comments"> 742 text file name. 743 </div> 744 745 746 747 748 749 750 <h3>Keywords</h3> 751 752 <h4 id="_getfile_keyword_error">error 753 754 755 756 757 758 759 760 761 </h4> 762 763 <div class="comments"> 764 =err error flag: 0=ok, 1=file not opened, 765 2=no lines in file. 766 </div> 767 768 <h4 id="_getfile_keyword_help">help 769 770 771 772 773 774 775 776 777 </h4> 778 779 <div class="comments"> 780 </div> 781 782 <h4 id="_getfile_keyword_quiet">quiet 783 784 785 786 787 788 789 790 791 </h4> 792 793 <div class="comments"> 794 means give no error message. 795 </div> 796 797 <h4 id="_getfile_keyword_lines">lines 798 799 800 801 802 803 804 805 806 </h4> 807 808 <div class="comments"> 809 =n Number of lines to read (def=all). 810 Much faster if number of lines is known. 811 Automatic for IDL 5.6 or later. 812 </div> 813 814 <h4 id="_getfile_keyword_find">find 815 816 817 818 819 820 821 822 823 </h4> 824 825 <div class="comments"> 826 search te file in the all !path directories (use 827 find.pro) 828 </div> 829 830 831 832 833 <h3>Version history</h3> 834 835 <h4>Version</h4><div class="preformat"> 836 $Id$ 837 </div> 838 <h4>History</h4><div class="preformat"> 743 839 R. Sterner, 20 Mar, 1990 744 840 R. Sterner, 1999 Apr 14 --- Added LINES=n keyword. … … 749 845 R. Sterner, 2004 Jan 27 --- Fixed to work in IDL as old as vers 4. 750 846 </div> 751 752 753 754 755 <h3>Parameters</h3>756 757 758 <h4 id="_getfile_param_filein">filein 759 760 761 762 763 764 765 766 767 </h4>768 769 <div class="comments"></div>770 771 772 773 774 775 776 <h3>Keywords</h3>777 778 <h4 id="_getfile_keyword_error">error 779 780 781 782 783 784 785 786 787 </h4>788 789 <div class="comments"></div>790 791 <h4 id="_getfile_keyword_help">help 792 793 794 795 796 797 798 799 800 </h4>801 802 <div class="comments"></div>803 804 <h4 id="_getfile_keyword_quiet">quiet 805 806 807 808 809 810 811 812 813 </h4>814 815 <div class="comments"></div>816 817 <h4 id="_getfile_keyword_lines">lines 818 819 820 821 822 823 824 825 826 </h4>827 828 <div class="comments"></div>829 830 <h4 id="_getfile_keyword_find">find 831 832 833 834 835 836 837 838 839 </h4>840 841 <div class="comments"></div>842 843 844 845 846 847 848 849 850 847 851 848
Note: See TracChangeset
for help on using the changeset viewer.
