String methods syntax

The syntax for each of the String class methods is shown below.

Square brackets indicate optional elements of the method invocation. See also the notation conventions for methods and the List of String methods.

%outString = string:AES128CBCdecrypt( key, initVector) Throws UnsupportedCrypto, InvalidCryptoKey, InvalidCryptoData, InvalidCryptoInitVector

%outString = string:AES128CBCencrypt( key, initVector) Throws UnsupportedCrypto, InvalidCryptoKey, InvalidCryptoData, InvalidCryptoInitVector

%outString = string:AES128decrypt( key) Throws UnsupportedCrypto, InvalidCryptoKey, InvalidCryptoData

%outString = string:AES128encrypt( key) Throws UnsupportedCrypto, InvalidCryptoKey, InvalidCryptoData

%outString = string:AES192CBCdecrypt( key, initVector) Throws UnsupportedCrypto, InvalidCryptoKey, InvalidCryptoData, InvalidCryptoInitVector

%outString = string:AES192CBCencrypt( key, initVector) Throws UnsupportedCrypto, InvalidCryptoKey, InvalidCryptoData, InvalidCryptoInitVector

%outString = string:AES192decrypt( key) Throws UnsupportedCrypto, InvalidCryptoKey, InvalidCryptoData

%outString = string:AES192encrypt( key) Throws UnsupportedCrypto, InvalidCryptoKey, InvalidCryptoData

%outString = string:AES256CBCdecrypt( key, initVector) Throws UnsupportedCrypto, InvalidCryptoKey, InvalidCryptoData, InvalidCryptoInitVector

%outString = string:AES256CBCencrypt( key, initVector) Throws UnsupportedCrypto, InvalidCryptoKey, InvalidCryptoData, InvalidCryptoInitVector

%outString = string:AES256decrypt( key) Throws UnsupportedCrypto, InvalidCryptoKey, InvalidCryptoData

%outString = string:AES256encrypt( key) Throws UnsupportedCrypto, InvalidCryptoKey, InvalidCryptoData

%outString = string:After( substring, [Start= number])

%outString = string:AsciiToEbcdic[( [CharacterEncode= boolean])] Throws CharacterTranslationException

%outString = string:Base64ToString Throws InvalidBase64Data

%outString = string:Before( substring, [Start= number])

%number = string:BinaryToFloat

%number = string:BinaryToInteger[( [Signed= boolean])]

%result = string:BitAndString( andBits, [Pad= c])

%result = string:BitClearString( bitNumber) Throws InvalidBitNumber

%count = string:BitCountString

%result = string:BitFlipString( bitNumber) Throws InvalidBitNumber

%result = string:BitOffString( offBits, [Pad= c])

%result = string:BitOnString( onBits, [Pad= c])

%result = string:BitOrString( orBits, [Pad= c])

%result = string:BitSetString( bitNumber) Throws InvalidBitNumber

%value = string:BitValueString( bitNumber) Throws InvalidBitNumber

%result = string:BitXorString( xorBits, [Pad= c])

%outString = string:Center( length, [Pad= c], [OffsetLeft= boolean])

%outString = string:Centre( length, [Pad= c], [OffsetLeft= boolean])

%certRequest = string:CertificateRequest[( [Country= string], - [State= string], [City= string], - [Organization= string], - [OrganizationalUnit= string], - [CommonName= string], - [SignatureAlgorithm= digestAlgorithm])] Throws PKCSError

%outString = string:Char( position)

%unicode = string:CharacterToUnicode( characterToUnicodeMap) Throws CharacterTranslationException

%certRequest = string:ClientCertificateRequest[( [Country= string], - [State= string], - [City= string], - [Organization= string], - [OrganizationalUnit= string], - [CommonName= string], - [Challenge= string], - [SignatureAlgorithm= digestAlgorithm])] Throws PKCSError

%outString = string:DEA128CBCdecrypt( key, initVector) Throws UnsupportedCrypto, InvalidCryptoKey, InvalidCryptoData, InvalidCryptoInitVector

%outString = string:DEA128CBCencrypt( key, initVector) Throws UnsupportedCrypto, InvalidCryptoKey, InvalidCryptoData, InvalidCryptoInitVector

%outString = string:DEA128decrypt( key) Throws UnsupportedCrypto, InvalidCryptoKey, InvalidCryptoData

%outString = string:DEA128encrypt( key) Throws UnsupportedCrypto, InvalidCryptoKey, InvalidCryptoData

%outString = string:DEA192CBCdecrypt( key, initVector) Throws UnsupportedCrypto, InvalidCryptoKey, InvalidCryptoData, InvalidCryptoInitVector

%outString = string:DEA192CBCencrypt( key, initVector) Throws UnsupportedCrypto, InvalidCryptoKey, InvalidCryptoData, InvalidCryptoInitVector

%outString = string:DEA192decrypt( key) Throws UnsupportedCrypto, InvalidCryptoKey, InvalidCryptoData

%outString = string:DEA192encrypt( key) Throws UnsupportedCrypto, InvalidCryptoKey, InvalidCryptoData

%outString = string:DEA64CBCdecrypt( key, initVector) Throws UnsupportedCrypto, InvalidCryptoKey, InvalidCryptoData, InvalidCryptoInitVector

%outString = string:DEA64CBCencrypt( key, initVector) Throws UnsupportedCrypto, InvalidCryptoKey, InvalidCryptoData, InvalidCryptoInitVector

%outString = string:DEA64decrypt( key) Throws UnsupportedCrypto, InvalidCryptoKey, InvalidCryptoData

%outString = string:DEA64encrypt( key) Throws UnsupportedCrypto, InvalidCryptoKey, InvalidCryptoData

%outString = string:Deflate[( [FixedCode= boolean], [LazyMatch= boolean], - [MaxChain= number])]

%doc = string:DerToXmlDoc Throws InvalidBerData

%outString = string:EbcdicToAscii[( [CharacterDecode= boolean])] Throws CharacterTranslationException

%unicode = string:EbcdicToUnicode[( [CharacterDecode= boolean], - [Untranslatable= unicode])] Throws CharacterTranslationException

%unicode = string:FormUrlDecodeUnicode[( [AllowUntranslatable= boolean])] Throws CharacterTranslationException

%outString = string:Gunzip Throws InvalidGZipData

%number = string:GunzipDatetimeNS Throws InvalidGZipData

%outString = string:GunzipFilename Throws InvalidGZipData

%outString = string:Gzip[( [FixedCode= boolean], [LazyMatch= boolean], - [MaxChain= number], [Filename= string], - [LastModified= number])]

%number = string:HexToInteger[( [Signed= boolean])] Throws InvalidHexData

%outString = string:HexToString Throws InvalidHexData

%outString = string:Inflate Throws InvalidDeflateData

%outString = string:Insert( insertedString, position)

%boolean = string:IsOneOf( list)

%boolean = string:IsStartOf( longerString, MinLength= number)

%outString = string:Left( length, [Pad= c])

%length = string:Length

%outString = string:MD5digest

%outString = string:MarksStoreCodeDecrement

%outString = string:MarksStoreCodeIncrement

%number = string:MarksStoreCodeToNumber

%sl = string:ParseLines[( [delims], [StripTrailingNull= boolean])]

%position = string:PositionIn( haystack, [Start= number])

%position = string:PositionOf( needle, [Start= number])

%outString = string:RC4decrypt( key)

%outString = string:RC4encrypt( key)

%doc = string:RSAPrivateKeyToXmlDoc Throws InvalidBerData

%number = string:RegexMatch( regex, [Options= string], - [CaptureList= stringlist]) Throws InvalidRegex

%outString = string:RegexReplace( regex, replacement, [Options= string]) Throws InvalidRegex

%sl = string:RegexSplit( regex, [Options= string], - [Add= regexSplitOutputOptions]) Throws InvalidRegex

%outString = string:Remove( substring, [Count= number])

%outString = string:Replace( substring, replacement, [Count= number])

%outString = string:Reverse

%outString = string:Right( length, [Pad= c])

%outString = string:SHA224digest

%outString = string:SHA256digest

%outString = string:SHAdigest

[%signedCert =] string:SignedCertificate( [PrivateKey=] string, - [[Signer=] string], - [[StartDate=] string], - [[EndDate=] string], - [[SerialNumber=] number], - [SignatureAlgorithm= digestAlgorithm]) Throws PKCSError

[%signedCert =] string:SignedClientCertificate( [PrivateKey=] string, - [[Signer=] string], - [[StartDate=] string], - [[EndDate=] string], - [[SerialNumber=] number], - [SignatureAlgorithm= digestAlgorithm]) Throws PKCSError

%boolean = string:StartsWith( abbreviation)

%outString = string:StringToBase64

%days = string:StringToDays( format, [[CentSpan=] number]) Throws InvalidDateString

%outString = string:StringToHex

%milliseconds = string:StringToMilliseconds( format, [[CentSpan=] number]) Throws InvalidDateString

%seconds = string:StringToSeconds( format, [[CentSpan=] number]) Throws InvalidDateString

%stringTokenizer = string:StringTokenizer[( [TokenChars= string], - [Spaces= string], - [Quotes= string], - [Separators= string])]

%outString = string:Substring( position, [length], [Pad= c])

%outString = string:TimeStringConvert( inputFormat, outputFormat, - [[CentSpan=] number]) Throws InvalidDateString

%outString = string:ToLower

%outString = string:ToString

%outString = string:ToUpper

%outString = string:Translate( characterMap)

%outString = string:TrimLeft( amount)

%outString = string:TrimRight( amount)

%unicode = string:U

%outString = string:Unspace[( [Spaces= string], [Leading= boolean], - [Trailing= boolean], [Compress= boolean])]

%unicode = string:UrlDecodeUnicode[( [AllowUntranslatable= boolean])] Throws CharacterTranslationException

%unicode = string:Utf16ToUnicode[( [AllowUntranslatable= boolean], - [Bom= utf16BOM])] Throws CharacterTranslationException

%unicode = string:Utf8ToUnicode[( [AllowUntranslatable= boolean])] Throws CharacterTranslationException

%selectedWord = string:Word( number, [Spaces= string])

%number = string:WordCount[( [Spaces= string])]

%number = string:WordNumberIn( haystack, [Spaces= string])

%number = string:WordNumberOf( needle, [Spaces= string])

%outString = string:Words( start, [count], [Spaces= string])

%outString = string:X

%doc = string:X509CertificateToXmlDoc Throws InvalidBerData

%doc = string:X509CrlToXmlDoc Throws InvalidBerData

%outString = string:Zip[( [FixedCode= boolean], [LazyMatch= boolean], - [MaxChain= number], [Filename= string], - [LastModified= number])]