Caché SQL Reference
LTRIM
[Back] [Next]
   
Server:docs2
Instance:LATEST
User:UnknownUser
 
-
Go to:
Search:    

A string function that returns a string with the leading blanks removed.
Synopsis
LTRIM(string-expression)

{fn LTRIM(string-expression)}
Arguments
string-expression A string expression, which can be the name of a column, a string literal, or the result of another scalar function, where the underlying data type can be represented as any character type (such as CHAR or VARCHAR).
Description
LTRIM removes the leading blanks from a string expression, and returns the string as type VARCHAR. If string-expression is NULL, LTRIM returns NULL. If string-expression is a string consisting entirely of blank spaces, LTRIM returns the empty string ('').
LTRIM leave trailing blanks; to remove trailing blanks, use RTRIM. To remove leading and/or trailing characters of any type, use TRIM. To pad a string with leading blanks or other characters, use LPAD. To create a string of blanks, use SPACE.
Note that LTRIM can be used as an ODBC scalar function (with the curly brace syntax) or as an SQL general function.
Examples
The following Embedded SQL example removes the five leading blanks from the string. It leaves the five trailing blanks:
   SET a="     Test string with 5 leading and 5 trailing spaces.     "
   &sql(SELECT {fn LTRIM(:a)} INTO :b)
   IF SQLCODE'=0 {
     WRITE !,"Error code ",SQLCODE }
   ELSE {
     WRITE !,"Before LTRIM",!,"start:",a,":end"
     WRITE !,"After LTRIM",!,"start:",b,":end" }
 
Returns:
Before LTRIM
start:     Test string with 5 leading and 5 trailing spaces.     :end
After LTRIM
start:Test string with 5 leading and 5 trailing spaces.     :end
See Also
RTRIM TRIM LPAD SPACE