AttachedFile Property

A file to append to PostData if the POST or PUT methods are used.

Syntax

 http.getAttachedFile([callback])
 http.setAttachedFile( attachedFile, [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 getAttachedFile([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 setAttachedFile([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

If this property contains a non-empty string, then if the HTTP 'POST' or 'PUT' methods are used (through the Post or Put methods), the contents of this property are appended to the HTTP request after any data in PostData.

An HTTP 'Content-Length' header is also added to request. Its value is the cumulative length of the PostData string and the file.

If you are attempting to upload a file to a receiving script, this property must be MIME encoded, or you should use the WebUpload component.

This property is not available at design time.

Data Type

String