FormVarValue Property

This property contains the form variable value for the current request.

Syntax

 webform.getFormVarValue(index, [callback])
 webform.setFormVarValue(index,  formVarValue, [callback])

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 getFormVarValue([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 setFormVarValue([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 contains the form variable value for the current request.

The size of the array is controlled by the FormVarCount property.

This property is not available at design time.

Data Type

String