FileVarFile Property

This property contains the path and filename of each file to be sent.

Syntax

 webupload.getFileVarFile(index, [callback])
 webupload.setFileVarFile(index,  fileVarFile, [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 getFileVarFile([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 setFileVarFile([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 path and filename of each file to be sent.

When the class is used as an upload client, this property must point to valid file name that will be sent to the server.

If FileVarInputData is set, this property may instead be set to the desired filename which will be used in the request.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

String