Whitebeam Object Definition

Site Map
 
Home
 
Application Guide
Reference
  Installation
  Configuration
  XML Markup
  JavaScript Classes
  ROM
  Templates
  Environment
  Dev Process
  Tools
  External Links
  Example libraries
Community
Contact Whitebeam
To-Do
Download
Credits
Licence
Whitebeam Users
 
 
 

Whitebeam Object Definition

Method Description

WbString.toBase64()

Produce a base-64 encoding of the argument.

See Also

WbString.fromBase64()   

Syntax

WbString = WbString.toBase64(input_string)

Parameters

The 'WbString.toBase64' method takes 1 parameter:

Name Type/Value Range/Length Description
input_stringstring  Required. String to be encoded

Results

The 'WbString.toBase64' method returns WbString:

Type/Value Range/Length Description
WbString   Returns a WbString instance containing the base-64 encoded form of the string parameter

Remarks

Encodes a string into a base-64 encoding suitable for transmission via SMTP.

Note: This is a method method on WbString and so is invoked as WbString.toBase64(str);

Example

base-64 encoding are generally used to encode non-printable binary data into a plain-text format that can be safely delivered over SMTP. This method takes a string and returns a new base-64 encoded version of that string.

Note: if you want to encode a binary object, such as an image, then use Binary.toBase64() method on the source binary object instead.

The method returns a new WbString instance that to all intents and purposes can be treated as a standard Javascript string object.

Whitebeam release 1.3.36
(loadtime : 10ms)