Difference between revisions of "STR PAD()"

From Recital Documentation Wiki
Jump to: navigation, search
 
Line 1: Line 1:
 
{{YLM to do}}
 
{{YLM to do}}
 
 
==Class==
 
==Class==
 
+
String Data
  
  
 
==Purpose==
 
==Purpose==
 
+
Function to pad out a character string to a defined length from the right
  
  
 
==Syntax==
 
==Syntax==
 
+
RPAD(<expC1>,<expN>,[<expC2>])
  
  
 
==See Also==
 
==See Also==
 
+
[[CENTER()]], [[LPAD()]], [[PADC()]], [[PADR()]], [[RPAD()]], [[STR()]], [[STRTRAN()]], [[STRZERO()]], [[STUFF()]]
  
  
 
==Description==
 
==Description==
 
+
The RPAD() function left-justifies a character string <expC1> and pads out the right of the string, to a total length of <expN> characters, with blank spaces.  The optional <expC2> may be used to pad <expC1> with a character string instead of blank spaces.  The RPAD() function is useful for creating fixed length character strings by padding them out with blanks.  If the string being processed is longer than the specified total length, it is truncated.  The RPAD() function is synonymous with the PADR() function.
  
  
 
==Example==
 
==Example==
 
<code lang="recital">
 
<code lang="recital">
 
+
? rpad("abc",6,"d")
 +
abcddd
 
</code>
 
</code>
  
==Products==
 
  
 +
==Products==
 +
Recital Server, Recital
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 +
[[Category:String Data]]
 +
[[Category:String Data Functions]]

Revision as of 15:29, 13 October 2009

Template:YLM to do

Class

String Data


Purpose

Function to pad out a character string to a defined length from the right


Syntax

RPAD(<expC1>,<expN>,[<expC2>])


See Also

CENTER(), LPAD(), PADC(), PADR(), RPAD(), STR(), STRTRAN(), STRZERO(), STUFF()


Description

The RPAD() function left-justifies a character string <expC1> and pads out the right of the string, to a total length of <expN> characters, with blank spaces. The optional <expC2> may be used to pad <expC1> with a character string instead of blank spaces. The RPAD() function is useful for creating fixed length character strings by padding them out with blanks. If the string being processed is longer than the specified total length, it is truncated. The RPAD() function is synonymous with the PADR() function.


Example

? rpad("abc",6,"d")
abcddd


Products

Recital Server, Recital