>  Docs Center  >  Libraries  >  JHU/APL/S1R  >  RESGET

RESGET

RESGET

Name


      RESGET

Purpose


      Get a variable from a results files.

Category


Calling Sequence


      resget, [name, val]

Inputs


      name = string with name of value to get. in
        May be truncated but will return first match.
        Case insensitive.

Keyword Parameters


Keywords


        FD=fd Optional file descriptor. Allows multiple res
          files to be used at once.
        FILE=res Name of *.res file to use. Will open if needed.
        /EXACT Only exact name will match.
        FOUND=i Returned header index where match was found.
        FROM=s Header index to start searching for name (def=0).
        HEADER=h Returned header as a string array.
        NUMBER=n Return both name and val for header
          entry number n. In this case name must be a variable.
        FULL_NAME=txt Returned full name.
        ADDRESS=pntr Byte address in file (first is 0) for
          start of array (scalars have no address, return -1).
        ERROR = e error code:
          0 = OK. Value returned normally.
          1 = Given index (NUMBER) references a comment line.
              Comment line is returned in name.
          2 = Given index (NUMBER) references last header line.
          3 = Given index (NUMBER) is out of range.
          4 = Header line contained no = or ==.
          5 = Name not found.
          6 = Invalid array type specified in header.
          7 = No results file open.

Outputs


      val = variable to contain results. out

Common Blocks


      results_common
      resget_com

Notes


      Notes: one of the results file utilities.
        See also resopen, resput, rescom, resclose.
        Must use resopen to open the file for read before
        using resget. Also must use resclose to close file.

Modification History


      R. Sterner, 18 Jun, 1991
      R. Sterner, 10 Dec, 1991 added HEADER=h and NUMBER=num.
      R. Sterner, 3 Jun, 1993 added FROM=s and FOUND=i.
      R. Sterner, 2000 Apr 11 --- Handled endian problem.
      R. Sterner, 2001 Mar 22 --- Added new IDL data types a few weeks
      ago, but added a bug that was just fixed for CHR type.
      R. Sterner, 2004 Feb 10 --- Supported extended file pointer (LONG64).
      R. Sterner, 2004 Sep 27 --- Added FD=fd to give file descriptor.
      R. Sterner, 2010 May 23 --- Converted arrays from () to [].
      R. Sterner, 2011 Mar 23 --- Added keyword FILE=file.
  Copyright (C) 1991, Johns Hopkins University/Applied Physics Laboratory
  This software may be used, copied, or redistributed as long as it is not
  sold and this copyright notice is reproduced on each copy made. This
  routine is provided as is without any express or implied warranties
  whatsoever. Other limitations apply as described in the file disclaimer.txt.



© 2019 Harris Geospatial Solutions, Inc. |  Legal
My Account    |    Store    |    Contact Us