IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

UpdateFile Property

A resource to be updated, deleted or created.

Syntax

 atom.getUpdateFile([callback])
 atom.setUpdateFile( updateFile, [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 getUpdateFile([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 setUpdateFile([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 allows you to create, update, and delete Atom resources using the Put method.

If UpdateFile is set to a local file, the content of that file will be used to form the content of the HTTP request.

Data Type

String

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0