494
PAD( ) Function
Pad/Truncate String
Format
PAD(string$,len[,pad_code][,char$][,ERR=stmtref])
Where:
char$
Optional string. Its first character is used to pad string$. If you omit
this, the default is to pad with blanks. String expression.
len
Desired length of string. Numeric expression.
pad_code[$] Optional parameter defining how to pad the string, either numeric
or string:
0 or L Pad on Left (right justify)
1 or R Pad on Right (left justify) - default
2 or C Centre in string
If omitted, the string is padded to the right.
stmtref
Program line number or label to transfer control to.
string$
String expression to be processed.
Returns
Value used in OPT= option.
Description
The PAD( ) function converts a given character string (string$) to the length (len)
specified. It makes the string the desired length either by truncating the string$ or by
appending the defined pad character. The default is to pad with spaces.
If the length you specify is less than zero, ProvideX returns an Error #41:
Invalid integer encountered (range error or non-integer).
See Also
Examples
The following code uses asterisks to pad a numeric value to a length of 30 characters:
00180 LET chq_amt=1.98,cust_name$="ACME INC."
00190 LET chq_amt$="*****"+PAD(STR(chq_amt),30,"*")
00200 PRINT 'CS',@(0,5),"Customer name :",PAD(cust_name$,20),"| ",
00210 PRINT @(0,6),chq_amt$
-:run
Customer name :ACME INC.
|
*****1.98**************************
This code sample illustrates the use of alphnumeric versus numeric pad types in the
PAD( ) function:
0100
! ^100 - PAD function
0110
Orig$="Test String",Char$=".",PadLen=20
0120
print 'LF',"Original String: "+@(24)+'BR'+Orig$+'ER'+'LF'
0130
Type=0,Type$="L"; gosub PadIt; print
0140
Type=1,Type$="R"; gosub PadIt; print