Click above to get retro games delivered to your door ever month!

 padl()              Left-pad a string with fill character
------------------------------------------------------------------------------
 Declaration
   string.hdr

 Syntax
   func char padl extern
   param const char cString, ;
         value uint uLength, ;
         value byte bChar

 Arguments
   cString is a character string.

   uLength is the length of the output string.

   bChar is the pad character.

 Return
   A string derived from the input string, with leading pad characters added
   to left-pad the string to the given length.

 Description
   This function returns a string with a length of uLength, made up of
   cString preceded by as many bChar characters that are needed to fill up
   the string to a length of uLength. The resulting string is left-padded
   to uLength.

   If the length of cString is larger than uLength then the string
   is trimmed to uLength.

 Example
   #define EXAMPLE_STRING
   #include example.hdr

   proc Test_padl
   ? padl( "hello  ",  3, '*' )  // Output: hel
   ? padl( "hello  ",  5, '*' )  // Output: hello
   ? padl( "hello  ", 10, '*' )  // Output: ***hello
   endproc

   proc main
   Test_padl()
   endproc