xad.ExtractFile(id, idx, dst$[, table])

The following tags are currently recognized in the optional table argument:

Password:

If the file you wish to extract is protected by a password, you have to specify this password here. If you don't specify this tag, the default password set using xad.SetDefaultPassword() is used.

Callback:

This tag allows you to pass a function that should be called from time to time. This can be useful if you'd like to show a status bar or something while the xad file is being extracted. The function will receive a table as its sole argument. The table will have the following fields initialized:

Action:

Initialized to "ExtractFile".

ID:

Contains the identifier of the xad archive.

Progress:

Contains a value between 0 and 100 indicating how much work has already been done.

UserData:

Contains the value you passed in the UserData argument (see below).

You can also pass user data that should be forwarded to your callback using the tag below.

UserData:

This tag can be set to arbitrary data that should be passed to the callback you passed in the Callback tag. If you specify this tag without the Callback tag, it is simply ignored.

id

identifier of the xad archive to use

idx

index of file to extract

dst$

desired destination file

table

optional: table containing further parameters