Codex SDK: Plug-In Directive Files

Custom Tool Directive File

The Custom Tool Directive File is a plain-text file that is created by the Codex runtime during plug-in defined archive tool operations. This directive file includes information about which files are to be processed by the custom tool (if applicable), and from which archive. A plug-in supporting custom archive tools needs to parse this directive file to obtain information about the tool operation desired.


source archive file
files for tool


source archive file

The full path to the source archive.

This is the first line of the directive file and is a mandatory field.

files for tool

The list of files in the archive to be processed by the custom tool. Each file to be processed will be on a separate line. Wildcards are NOT accepted. If the files are contained inside folders in the archive, the folder information for those archives will be specified exactly as returned from the archive contents listing of the GetArchiveInfoEx function.

If the custom tool operates on an entire archive and not files inside the archive (such as a Self Extracting Archive creation tool), files specified in this list may be ignored.

This field starts on the second line and may also take place on the following lines of the directive file. This is an optional field.


The character literal '$' (without the quotes). Indicates the list of files for the custom tool has ended. Also indicates the end of the directive file.

This is a mandatory field. It can occur anywhere in the directive file starting from the second line, depending on how many lines were taken up by the files for tool field.


If the "Delete Files in Archive" custom tool directive file for a ZIP plug-in contains the following:

c:\my documents\presentation plan
graphics\sales figures.jpg

then, the ZIP plug-in should:

  1. Open the archive "" contained in the "c:\backups" folder,

  2. Delete the files "presentation.ppt" and "presentation.doc" in the archive,

  3. Delete the file "sales figures.jpg" found in the "graphics" folder of the "" archive,

  4. Finish processing.

See Also

SDK Overview, Plug-In Features, Compression Directive File, Decompression Directive File