Pileus Git - ~andy/rsl/blob - doc/RSL_select_fields.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
   2 <HTML>
   3 <HEAD>
   4    <TITLE></TITLE>
   5    <META NAME="GENERATOR" CONTENT="Mozilla/3.01Gold (X11; I; Linux 2.0.28 i686) [Netscape]">
   6 </HEAD>
   7 <BODY>
   8
   9 <P><A HREF="index.html"><IMG SRC="rsl.gif" HEIGHT=100 WIDTH=100></A><A HREF="index.html">
  10 </A>
  11 <HR></P>
  12
  13 <P><BR>
  14 </P>
  15
  16 <H1>RSL_select_fields</H1>
  17
  18 <P>
  19 <HR></P>
  20
  21 <H3>Synopsis</H3>
  22
  23 <P><B>#include &quot;rsl.h&quot;<BR>
  24 void RSL_select_fields(char *field_type, [char *field_type...], NULL);</B><BR>
  25
  26 <HR></P>
  27
  28 <H3>Description</H3>
  29
  30 <P>Call this routine prior to any ingest routine and only the field types
  31 specified will be ingested. The drastically reduces memory requirements,
  32 especially if you're only interesed in one field type. Lassen, for instance,
  33 can have more than 5 field types which collectively can occupy an enormous
  34 amount of memory. By default, all field types are ingested. field_type
  35 is not case sensitive. Specify NULL as the last argument. This signals
  36 this routine when to stop parsing the field types.</P>
  37
  38 <P>The list of possible field types is: &quot;all&quot;, &quot;none&quot;,
  39 &quot;dz&quot;, &quot;vr&quot; &quot;cz&quot;, &quot;zt&quot;, &quot;dr&quot;,
  40 &quot;lr&quot;, &quot;zd&quot;, &quot;dm&quot;, &quot;rh&quot;, &quot;ph&quot;,
  41 &quot;xz&quot;, &quot;cd&quot;, &quot;mz&quot;, &quot;md&quot;, &quot;ze&quot;,
  42 &quot;ve&quot;, &quot;kd&quot;, &quot;ti&quot;.</P>
  43
  44 <P>Action or side-effects: A second call to this function over-rides any
  45 previous settings. In other words, multiple calls are not additive. So,
  46 to get both DZ and VR volumes, use:<BR>
  47 RSL_select_fields(&quot;dz&quot;, &quot;vr&quot;, NULL); -- Read both DZ
  48 and VR.<BR>
  49 and not:<BR>
  50 RSL_select_fields(&quot;dz&quot;, NULL); -- Read only DZ.<BR>
  51 RSL_select_fields(&quot;vr&quot;, NULL); -- Read only VR, no DZ.</P>
  52
  53 <P><BR>
  54
  55 <HR></P>
  56
  57 <H3>Return value</H3>
  58
  59 <P>Upon successful completion, RSL_select_fields silently sets a hidden
  60 array that RSL_anyformat_to_radar accesses for memory allocation.<BR>
  61
  62 <HR></P>
  63
  64 <H3>See also</H3>
  65
  66 <P><A HREF="RSL_anyformat_to_radar.html">RSL_anyformat_to_radar</A>.<BR>
  67
  68 <HR>Author: <A HREF="john.merritt.html">John H. Merritt</A>. </P>
  69
  70 </BODY>
  71 </HTML>