leftjustify.pro

NRAO GBTIDL
Produced by IDL 7.1.1
User Documentation

prev file | next file view single page | view frames | update routines

SUMMARY: fields | routine DETAILS: routine

./toolbox
leftjustify.pro

Last modification date:: Wed Sep 28 13:27:11 2016

leftjustify

function leftjustify(in, width[, flag])

Function to return the input string, left justified at the desired width. Whitespace is first trimmed from the input string according to flag and then enough spaces are appended to the input string to pad it out to the desired width. If the input string is wider than the desired width, after trimming, it is truncated so that the returned string always is of the desired width.

Returns: the padded string
Version: $Id$

Parameters

in
in, required
string The input string to pad.

width
in, required
integer The desired width. Must be a positive integer.

flag
in, optional
integer (def. 0) This is passed directly to strtrim to control on in is trimmed prior to padding. If flag is 0, trailing whitespace is trimmed, if flag is 1, leading whitepsace is trimed, and if flag is 2, both are trimmed.

Produced by IDLdoc 1.6 on Wed Sep 28 13:27:39 2016

Parameters
in in, required string	The input string to pad.
width in, required integer	The desired width. Must be a positive integer.
flag in, optional integer (def. 0)	This is passed directly to strtrim to control on in is trimmed prior to padding. If flag is 0, trailing whitespace is trimmed, if flag is 1, leading whitepsace is trimed, and if flag is 2, both are trimmed.