PADLEFT()

Fills string to a certain length on the left

Syntax

       PADLEFT( <cString>, <nLength>, [<cChar|nChar>] ) -> cString

Arguments

<cString> Designates the string that is processed.

<nLength> Designates the new length for <cString>.

<cChar|nChar> Designates the character with which the beginning of the <cString> string is filled. The default value is a space, CHR(32).

Returns

The processed <cString> is returned.

Description

PADLEFT() allows you to pad the beginning of character strings with characters, in accordance with a length specification. Spaces or any other characters you choose can be used.

Notes

. The function works like the Harbour RIGHT() function when <nLength> is shorter than the length of <cString>. If <nLength> is negative, PADLEFT() returns a null string. . When the <cCharacter|nCharacter> parameter is not specified, spaces are automatically used for padding.

Examples

       .  The function works like RIGHT():
          ? PADLEFT("123456", 4)              // "3456"
       .  Pad the left with spaces:
          ? PADLEFT("123456", 8)              // "  123456"
       .  Pad the left with the "." character:
          ? PADLEFT("123456", 8, ".")         // "..123456"

Compliance

PADLEFT() is compatible with CT3’s PADLEFT().

Platforms

All

Files

Source is pad.c, library is libct.

Seealso

PADRIGHT()