Changeset 151 for trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRUCTURE/extractstru.html
- Timestamp:
- 08/09/06 12:21:11 (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRUCTURE/extractstru.html
r138 r151 696 696 </div> 697 697 698 <div id="file_comments"></div> 698 <div id="file_comments"> 699 extract elements of a structure to constitute a new structure. 700 </div> 699 701 700 702 … … 711 713 <div class="routine_details" id="_extractstru"> 712 714 713 <h2><a class="top" href="#container">top</a>extractstru </h2> 715 <h2><a class="top" href="#container">top</a>extractstru <span class="categories"> 716 utilities 717 </span></h2> 714 718 715 719 <p class="header"> 716 <span class="result">result = </span>extractstru(<span class="result"><a href="#_extractstru_param_stru">stru</a>, <a href="#_extractstru_param_liste">liste</a></span>, <a href="#_extractstru_keyword_GARDE">GARDE</a>=<span class="result">GARDE</span>, <a href="#_extractstru_keyword_VIRE">VIRE</a>=<span class="result">VIRE</span>)</p> 720 <span class="result">result = </span>extractstru(<span class="result"><a href="#_extractstru_param_stru">stru</a>, <a href="#_extractstru_param_liste">liste</a></span>, <a href="#_extractstru_keyword_KEEP">KEEP</a>=<span class="result">KEEP</span>, <a href="#_extractstru_keyword_DELETE">DELETE</a>=<span class="result">DELETE</span>)</p> 721 722 <div class="comments"></div> 723 724 <h3>Return value</h3><div class="preformat"> 725 A structure or -1 in case of problem 726 </div> 727 728 729 <h3>Parameters</h3> 730 731 732 <h4 id="_extractstru_param_stru">stru 733 <span class="attr">in</span> 734 735 736 <span class="attr">required</span> 737 738 739 740 741 </h4> 717 742 718 743 <div class="comments"> 719 NAME:extractstru 720 721 PURPOSE:extrait des elements d''une structure pour constituer une 722 nouvelle structure 723 724 CATEGORY: dibouille sur les structures 725 726 CALLING SEQUENCE: res = extractstru(stru, liste) 727 728 INPUTS: 729 730 stru: une structure 731 732 liste: un vecteur de string comportant les noms des elements de 733 stru a virer (par DEFAUT) ou a garder (si GARDE est active) 734 735 KEYWORD PARAMETERS: 736 737 /GARDE: specifie que la liste donnee concerne les elements de 738 stru a garder 739 740 /VIRE: specifie que la liste donnee concerne les elements de 741 stru a virer. Ce mot cle est active par defaut 742 743 OUTPUTS:une stucture ou -1 en cas de pb 744 745 COMMON BLOCKS: 746 747 SIDE EFFECTS: 748 749 RESTRICTIONS: none !!! 750 liste peut contenir des noms d''elements qui ne sont pas ds stru, 751 le programme se debrouille avec 752 753 EXAMPLE: 744 A structure 745 </div> 746 747 <h4 id="_extractstru_param_liste">liste 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 A vector of string including names of STRU to be deleted 760 (by default) or to be kept (if KEEP is activated). 761 </div> 762 763 764 765 766 767 768 <h3>Keywords</h3> 769 770 <h4 id="_extractstru_keyword_KEEP">KEEP 771 772 773 774 775 776 777 778 779 </h4> 780 781 <div class="comments"> 782 Specify that the given liste concern elements of STRU to be kept. 783 </div> 784 785 <h4 id="_extractstru_keyword_DELETE">DELETE 786 787 788 789 790 791 792 793 794 </h4> 795 796 <div class="comments">: 797 Specify that the given liste concern elements of STRU to be deleted. 798 This keyword is activated by default. 799 </div> 800 801 802 803 <h3>Examples</h3><div class="preformat"> 754 804 755 805 IDL> extra=get_extra(/ok, year=1999, age_capitaine=35 ) … … 762 812 ** Structure <831afac>, 1 tags, length=2, refs=1: 763 813 AGE_CAPITAINE INT 35 764 IDL> help, extractstru(extra,['ok','hhuihi','YEAR'],/ garde),/stru814 IDL> help, extractstru(extra,['ok','hhuihi','YEAR'],/keep),/stru 765 815 ** Structure <834bbc4>, 2 tags, length=4, refs=1: 766 816 OK INT 1 767 817 YEAR INT 1999 768 818 </div> 769 770 771 772 773 <h3>Parameters</h3> 774 775 776 <h4 id="_extractstru_param_stru">stru 777 778 779 780 781 782 783 784 785 </h4> 786 787 <div class="comments"></div> 788 789 <h4 id="_extractstru_param_liste">liste 790 791 792 793 794 795 796 797 798 </h4> 799 800 <div class="comments"></div> 801 802 803 804 805 806 807 <h3>Keywords</h3> 808 809 <h4 id="_extractstru_keyword_GARDE">GARDE 810 811 812 813 814 815 816 817 818 </h4> 819 820 <div class="comments"></div> 821 822 <h4 id="_extractstru_keyword_VIRE">VIRE 823 824 825 826 827 828 829 830 831 </h4> 832 833 <div class="comments"></div> 834 835 836 837 838 839 840 841 819 <h3>Version history</h3> 820 821 <h4>Version</h4><div class="preformat"> 822 $Id: extractstru.pro 150 2006-08-09 10:12:54Z navarro $ 823 </div> 824 <h4>History</h4><div class="preformat"></div> 842 825 843 826
Note: See TracChangeset
for help on using the changeset viewer.
