AddFormVar Method

Adds a form variable and the corresponding value.

Syntax

webform.addFormVar(varName, varValue, [callback])

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 this 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

Please refer to the FormVars properties for more information on form variables and how they are managed.

Example (Submit Post)

WebFormControl.Reset()
WebFormControl.AddFormVar("formvarname1", "formvarvalue1")
WebFormControl.AddFormVar("formvarname2", "formvarvalue2")
WebFormControl.Submit()

WebFormControl.Reset()
WebFormControl.FormVarCount = 2
WebFormControl.FormVarName(0) = "formvarname1"
WebFormControl.FormVarValue(0) = "formvarvalue1"
WebFormControl.FormVarName(1) = "formvarname2"
WebFormControl.FormVarValue(1) = "formvarvalue2"
WebFormControl.SubmitTo(url)