ph_trim PowerHome formula function
Description
Trims the specified string using the
specified trim
type.
Syntax
ph_trim ( data, type, trim
)
| Argument |
Description |
| data |
String. The string you would to perform the trim operation
on. |
| type |
Integer. The type of trim operation to perform. See usage
below. |
|
trim
|
String. A set of characters that you
would like to have trimmed from the string. Use an empty string "" to trim
only spaces.
|
Return value
String. Returns the
trimmed string.
Usage
Use this function to perform trim
operations on a string. Most trim operations only remove space characters but by
specifiying a group of characters in the trim parameter, you can trim other
characters as well.
The valid values for the type parameter are detailed
below:
| 0 |
Performs a left trim. Characters will be removed from the
left |
| 1 |
Performs a right trim. Characters will be removed from the
right |
|
2
|
Performs both a left and right trim.
Characters will be removed from both the left and
the right.
|
Examples
The following examples demonstrate typical syntax/usage for this function.
ph_trim(" , | & This
is a test. & |",2," ,|&")
The above example will return "This is a
test."