Opened Property

Indicates whether class is currently in edit mode.

Syntax

 archivewriter.getOpened([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 getOpened([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 setOpened([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 set to true if the archive control is in edit mode, meaning it was openedwith Open or created with CreateNew call.

When an archive is opened, you can add new files to it, remove existing files, or modifyencryption attributes.

This property is read-only.

Data Type

Boolean