ArchiveType Property

The type of the archive.

Syntax

 archivewriter.getArchiveType([callback])

Possible Values

  0 (aftUnknown), 
  1 (aftZip), 
  2 (aftGzip), 
  3 (aftBzip2), 
  4 (aftTar), 
  5 (aftTarGzip), 
  6 (aftTarBzip2), 
  7 (aftSFX)

Default Value

0

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 getArchiveType([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 setArchiveType([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 indicates the type of the opened archive.

This property is read-only.

Data Type

Integer