/* --------------------------------
** FUNCTION:
**   fnTrimSpaceFromString 
** DESCRIPTION:
**   This function trims 'whitespace' from the end and beginning
**   of a specified string. In this case whitespace is
**   defined as space and tab characters, and newlines
** DEPENDENCIES:
**   fnStripLeadingSpaceFromString
**   fnStripTrailingSpaceFromString
** SEE ALSO:
** DATE:
** 
   -------------------------------- */

function fnTrimSpaceFromString(sString, sWhiteSpaceIndicator) 
{
  //-->-->-->-->-->-->-->-->-->-->-->-->
  //-- The sWhiteSpaceIndicator variable is a way
  //-- of indicating what sort of white space should be
  //-- removed from the beginning of the specified
  //-- string. If this variable contains 'n' then
  //-- newline characters will be removed
  //-- (\n escape characters) if 't' then tabs (\t)
  //-- etc

  if (sWhiteSpaceIndicator == null)
    { sWhiteSpaceIndicator = "snt"; }

  if (sString == null)
  {
    //-->-->-->-->-->-->-->-->-->-->-->-->
    //-- write out some nasty error message
    //-- somewhere, mortally insulting the programmer
    //-- for such a ridiculous error
    return -1;
  }

  var sReturn = sString;

  sReturn = fnStripLeadingSpaceFromString(sReturn, sWhiteSpaceIndicator);
  sReturn = fnStripTrailingSpaceFromString(sReturn, sWhiteSpaceIndicator);

  return sReturn;

} //-- fnTrimSpaceFromString()