FormVarName Property

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

Syntax

 ipn.getFormVarName(index, [callback])
 ipn.setFormVarName(index,  formVarName, [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 getFormVarName([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 setFormVarName([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 name for the current request. If you are emulating the behavior of an existing HTML web form, this property will contain the name attribute of the 'INPUT' tag in the form which you are emulating.

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

This property is not available at design time.

Data Type

String