Encoding Property

The encoding type for the form data.

Syntax

 webform.getEncoding([callback])
 webform.setEncoding( encoding, [callback])

Possible Values

  0 (encURLEncoding), 
  1 (encMultipartFormData), 
  2 (encQueryString)

Default Value

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getEncoding([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setEncoding([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property determines how the class encodes the form contents. It is equivalent to the 'ENCTYPE' attribute of an HTML form.

It can take one of the following values:


encURLEncoding (0)	This is the most common encoding for HTML form contents.
encMultipartFormData (1)	This is MIME encoding allowing transmission of binary data.
encQueryString (2)	This is an older form of encoding where the actual parameters are appended to the URL query string. (Generally not recommended because most servers limit the size of the URL to less than 1K or 2K).

Data Type

Integer