FileWriteMode Property

Controls how the output file is opened.

Syntax

 ediwriter.getFileWriteMode([callback])
 ediwriter.setFileWriteMode( fileWriteMode, [callback])

Possible Values

  0 (fwmCreate), 
  1 (fwmOverwrite), 
  2 (fwmAppend)

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 getFileWriteMode([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 setFileWriteMode([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 controls how the component will open the output file specified in OutputFile. Possible values are:


fwmCreate (0)	Always create a new file. If the file already exists, an error will be raised.
fwmOverwrite (1)	If the output file already exists, it will be overwritten.
fwmAppend (2)	If the output file already exists, data will be appended to it.

Data Type

Integer