home contribute faq download

FunctX XQuery Functions

functx:pad-integer-to-length

Pads an integer to a desired length by adding leading zeros

Google
Webxqueryfunctions.com

Description

The functx:pad-integer-to-length function returns $integerToPad concatenated with enough leading zeros to make its length $length. The function will raise an error if $integerToPad is longer than $length.

Arguments and Return Type

NameTypeDescription
$integerToPad xs:anyAtomicType? the integer to pad
$length xs:integer the desired length
return value xs:string

XQuery Function Declaration

See XSLT definition.
declare namespace functx = "http://www.functx.com";
declare function functx:pad-integer-to-length
  ( $integerToPad as xs:anyAtomicType? ,
    $length as xs:integer )  as xs:string {

   if ($length < string-length(string($integerToPad)))
   then error(xs:QName('functx:Integer_Longer_Than_Length'))
   else concat
         (functx:repeat-string(
            '0',$length - string-length(string($integerToPad))),
          string($integerToPad))
 } ;

Examples

XQuery ExampleResults
functx:pad-integer-to-length(12, 6)
000012
functx:pad-integer-to-length(1, 6)
000001
functx:pad-integer-to-length(12, 2)
12

Depends On

functx:repeat-stringRepeats a string a given number of times

See Also

functx:pad-string-to-lengthPads a string to a desired length
functx:repeat-stringRepeats a string a given number of times

History

Published OnLast UpdatedContributor(s)
2006-06-272007-02-26Priscilla Walmsley, Datypic, pwalmsley@datypic.com, http://www.datypic.com
Datypic XQuery Services

Recommended Reading:

XQuery