Overwrite Property

Indicates whether or not the component should overwrite files when writing IDoc data.

Syntax

 idocwriter.getOverwrite([callback])
 idocwriter.setOverwrite( overwrite, [callback])

Default Value

FALSE

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 getOverwrite([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 setOverwrite([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 is a flag indicating whether or not the class should overwrite the file specified by OutputFile. If Overwrite is false, an error will be thrown whenever OutputFile exists before StartIDoc is called.

This property is not available at design time.

Data Type

Boolean