StringToBase64 (String function)

This intrinsic function returns the base-64 encoded value of the method object string.

StringToBase64 is available as of version 7.2 of the Sirius Mods.

StringToBase64 syntax

  %outStr = string:StringToBase64                                                                             

Syntax Terms

%outStr

A string variable to receive the base-64 encoded value of the method object string.

string

The string to be base-64 encoded.

Usage Notes

• Base-64 encoding is useful for encoding strings that might contain binary or other characters that could cause problems in certain contexts. For example, binary characters can be problematic when sent in e-mail.
  Base-64 encoding is an alternative to hexadecimal encoding. Hexadecimal encoding has the advantage that it's simpler, but as the disadvantage that it requires two bytes for every encoded byte. Base-64 encoding, because it uses more characters (64, as the name would suggest), only requires four bytes for every three encoded bytes.
• A complete explanation of base-64 encoding can be easily found on the Internet or in many software textbooks.
• The StringToBase64 function returns the standard base-64 encoding of a string, where the encoded string is padded out to an even multiple of four bytes by appending equal signs.
• The inverse of StringToBase64 is Base64toString

Examples

The following statement displays '8PHy8/T19vf4+Q==':

   printText {'0123456789':stringTobase64}

See also

List of intrinsic String methods