# coyote: LEFTJUSTIFY

- coyote/Utilities
- [Source code]

NAME

      LEFTJUSTIFY

PURPOSE

      This is a utility routine to create a string that is left-justified with
      respect to a string width.

AUTHOR

      FANNING SOFTWARE CONSULTING
      David Fanning, Ph.D.
      1645 Sheely Drive
      Fort Collins, CO 80526 USA
      Phone: 970-221-0438
      E-mail: david@idlcoyote.com
      Coyote's Guide to IDL Programming: http://www.idlcoyote.com

CATEGORY

      Utilities

CALLING SEQUENCE

      justifiedString = LeftJustify(string, width)

AUGUMENTS

      string:      The string that is to be left-justified. If not supplied, a null
                   string is returned and no error is issued.
      width:       The final width of the left-justified string. The width must be
                   longer than the length of the string or an error results. Default: 50.

KEYWORDS

      None.

RETURN VALUE

      justifiedString: A string of WIDTH, with the string left-justified and the rest of the string
                    filled with blank characters.

MODIFICATION HISTORY

      Written by:  David W. Fanning, 26 January 2009.