- 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/getwrd.html
r138 r142 696 696 </div> 697 697 698 <div id="file_comments"></div> 698 <div id="file_comments"> 699 Return the n'th word from a text string. 700 </div> 699 701 700 702 … … 711 713 <div class="routine_details" id="_GETWRD"> 712 714 713 <h2><a class="top" href="#container">top</a>GETWRD </h2> 715 <h2><a class="top" href="#container">top</a>GETWRD <span class="categories"> 716 </span></h2> 714 717 715 718 <p class="header"> … … 717 720 718 721 <div class="comments"> 719 NAME: 720 GETWRD 721 PURPOSE: 722 Return the n'th word from a text string. 723 CATEGORY: 724 CALLING SEQUENCE: 725 wrd = getwrd(txt, n, [m]) 726 INPUTS: 727 txt = text string to extract from. in 728 The first element is used if txt is an array. 729 n = word number to get (first = 0 = def). in 730 m = optional last word number to get. in 731 KEYWORD PARAMETERS: 732 Keywords: 733 LOCATION = l. Return word n string location. 734 DELIMITER = d. Set word delimiter (def = space & tab). 735 /LAST means n is offset from last word. So n=0 gives 736 last word, n=-1 gives next to last, ... 737 If n=-2 and m=0 then last 3 words are returned. 738 /NOTRIM suppresses whitespace trimming on ends. 739 NWORDS=n. Returns number of words in string. 740 OUTPUTS: 741 wrd = returned word or words. out 742 COMMON BLOCKS: 743 getwrd_com 744 NOTES: 745 Note: If a NULL string is given (txt="") then the last string 746 given is used. This saves finding the words again. 747 If m > n wrd will be a string of words from word n to 748 word m. If no m is given wrd will be a single word. 749 n<0 returns text starting at word abs(n) to string end 750 If n is out of range then a null string is returned. 751 See also nwrds. 752 MODIFICATION HISTORY: 722 </div> 723 724 <h3>Return value</h3><div class="preformat"> wrd = returned word or words. 725 </div> 726 727 728 <h3>Parameters</h3> 729 730 731 <h4 id="_GETWRD_param_TXTSTR">TXTSTR 732 <span class="attr">in</span> 733 734 735 <span class="attr">required</span> 736 737 738 739 740 </h4> 741 742 <div class="comments"> 743 text string to extract from. 744 The first element is used if txt is an array. 745 </div> 746 747 <h4 id="_GETWRD_param_NTH">NTH 748 <span class="attr">in</span> 749 750 751 <span class="attr">required</span> 752 753 754 755 756 </h4> 757 758 <div class="comments"> 759 word number to get (first = 0 = def) 760 </div> 761 762 <h4 id="_GETWRD_param_MTH">MTH 763 <span class="attr">in</span> 764 765 766 <span class="attr">required</span> 767 768 769 770 771 </h4> 772 773 <div class="comments"> 774 optional last word number to get. 775 </div> 776 777 778 779 780 781 782 <h3>Keywords</h3> 783 784 <h4 id="_GETWRD_keyword_help">help 785 786 787 788 789 790 791 792 793 </h4> 794 795 <div class="comments"></div> 796 797 <h4 id="_GETWRD_keyword_location">location 798 799 800 801 802 803 804 805 806 </h4> 807 808 <div class="comments"> 809 = l. Return word n string location. 810 </div> 811 812 <h4 id="_GETWRD_keyword_delimiter">delimiter 813 814 815 816 817 818 819 820 821 </h4> 822 823 <div class="comments"> 824 = d. Set word delimiter (def = space & tab). 825 </div> 826 827 <h4 id="_GETWRD_keyword_notrim">notrim 828 829 830 831 832 833 834 835 836 </h4> 837 838 <div class="comments"> 839 suppresses whitespace trimming on ends. 840 </div> 841 842 <h4 id="_GETWRD_keyword_last">last 843 844 845 846 847 848 849 850 851 </h4> 852 853 <div class="comments"> 854 means n is offset from last word. So n=0 gives 855 last word, n=-1 gives next to last, ... 856 If n=-2 and m=0 then last 3 words are returned. 857 </div> 858 859 <h4 id="_GETWRD_keyword_nwords">nwords 860 861 862 863 864 865 866 867 868 </h4> 869 870 <div class="comments"> 871 = n. Returns number of words in string. 872 </div> 873 874 875 876 877 <h3>Version history</h3> 878 879 <h4>Version</h4><div class="preformat"> 880 $Id$ 881 </div> 882 <h4>History</h4><div class="preformat"> 753 883 Ray Sterner, 6 Jan, 1985. 754 884 R. Sterner, Fall 1989 --- converted to SUN. … … 766 896 sold and this copyright notice is reproduced on each copy made. This 767 897 routine is provided as is without any express or implied warranties 768 whatsoever. Other limitations apply as described in the file disclaimer.txt.</div> 769 770 771 772 773 <h3>Parameters</h3> 774 775 776 <h4 id="_GETWRD_param_TXTSTR">TXTSTR 777 778 779 780 781 782 783 784 785 </h4> 786 787 <div class="comments"></div> 788 789 <h4 id="_GETWRD_param_NTH">NTH 790 791 792 793 794 795 796 797 798 </h4> 799 800 <div class="comments"></div> 801 802 <h4 id="_GETWRD_param_MTH">MTH 803 804 805 806 807 808 809 810 811 </h4> 812 813 <div class="comments"></div> 814 815 816 817 818 819 820 <h3>Keywords</h3> 821 822 <h4 id="_GETWRD_keyword_help">help 823 824 825 826 827 828 829 830 831 </h4> 832 833 <div class="comments"></div> 834 835 <h4 id="_GETWRD_keyword_location">location 836 837 838 839 840 841 842 843 844 </h4> 845 846 <div class="comments"></div> 847 848 <h4 id="_GETWRD_keyword_delimiter">delimiter 849 850 851 852 853 854 855 856 857 </h4> 858 859 <div class="comments"></div> 860 861 <h4 id="_GETWRD_keyword_notrim">notrim 862 863 864 865 866 867 868 869 870 </h4> 871 872 <div class="comments"></div> 873 874 <h4 id="_GETWRD_keyword_last">last 875 876 877 878 879 880 881 882 883 </h4> 884 885 <div class="comments"></div> 886 887 <h4 id="_GETWRD_keyword_nwords">nwords 888 889 890 891 892 893 894 895 896 </h4> 897 898 <div class="comments"></div> 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 898 whatsoever. Other limitations apply as described in the file disclaimer.txt. 899 </div> 900 901 902 <h3>Known issues</h3> 903 904 905 906 <h4>Restrictions</h4><div class="preformat"> 907 If a NULL string is given (txt="") then the last string 908 given is used. This saves finding the words again. 909 If m > n wrd will be a string of words from word n to 910 word m. If no m is given wrd will be a single word. 911 n<0 returns text starting at word abs(n) to string end 912 If n is out of range then a null string is returned. 913 See also nwrds. 914 </div> 914 915 915 916 <h3>Other attributes</h3> 916 917 917 918 918 919 <h4>Uses routines</h4><div class="preformat"> 920 getwrd_com 921 </div> 919 922 920 923
Note: See TracChangeset
for help on using the changeset viewer.
