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

DROP_COMMENTS

DROP_COMMENTS

Name


      DROP_COMMENTS

Purpose


      Drop comment and null lines from a text array.

Category


Calling Sequence


      out = drop_comments(in)

Inputs


      in = input text array. in

Keyword Parameters


Keywords


        IGNORE=ig Text string of allowed comment characters.
          Default is ';*', so lines starting with the characters
          * or ; in column 1 are considered comments and dropped.
        /NOTRIM means don't do a strtrim on text array.
          By default any line with white space but no text is
          considered a null line and dropped. If /NOTRIM is
          specified only true null lines are dropped.
        /TRAILING means drop any trailing comments on each line.
          Be careful of the default comment characters for this.
        /NULL Keep null lines.
        ERROR=err Error flag: 0=OK, 1=All lines dropped.
        /QUIET Means suppress error messages.
        INDEX=indx Indices in original input of retained lines.

Outputs


      out = processed text array. out

Common Blocks


Notes


Modification History


      R. Sterner, 18 May, 1993
      R. Sterner, 1995 Jun 26 --- added keyword INDEX=indx.
      R. Sterner, 1995 Oct 27 --- added keyword /TRAILING.
      R. Sterner, 2007 Dec 27 --- Added /NULL.
      R. Sterner, 2010 May 03 --- Converted arrays from () to [].
  Copyright (C) 1993, 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