Codex SDK: Plug-In DLL Functions

CodexStandardFunction

The CodexStandardFunction function performs a standard or plug-in defined archive function. This is a plug-in defined function.

 

VOID CodexStandardFunction(
    LPCTSTR lpFunction,      // standard or custom archive function description
    LPCTSTR lpParam1,        // first function parameter
    LPCTSTR lpParam2,        // second function parameter
);

Parameters

lpFunction

[in] Pointer to a null-terminated string that specifies the archive function to perform.

This parameter may be a standard archive function or a plug-in defined archive function.

Below is the list of standard Codex defined archive functions:

Function

Meaning

info

The plug-in is to extract information about the archive it supports. This parameter will never be passed to this function. If a plug-in publishes this function, the function will be used through the GetArchiveInfoEx function.

encode

(may be named differently by plug-in)

The plug-in is to compress a collection of files into an archive. Whether the archive already exists is not specified.

encodesetup

(may be named differently by plug-in)

The plug-in is to configure its compression settings through its custom compression profile editor.

decode

(may be named differently by plug-in)

The plug-in is to decompress a collection of files from an archive.

decodesetup

(may be named differently by plug-in)

The plug-in is to configure its decompression settings through its custom decompression profile editor.

If these standard functions have been named differently by the plug-in, the plug-in must be able to interpret them correctly upon being passed those values by the CodexStandardFunction. See verbs in Plug-In Registration for more information.

The plug-in may also publish a custom set of plug-in defined archive functions. If the plug-in has published a custom set of archive tools, the verbs for those tools may be passed as functions in the lpFunction parameter. See verbs in Plug-In Registration for more information.

lpParam1

[in] Pointer to a null-terminated string that specifies the first function parameter. This parameter has meaning that changes according to the value of the lpFunction parameter.

For standard Codex defined archive functions:

Function

Parameter 1 Meaning

info

Not used.

encode

Full path to the compression directive file.

encodesetup

Full path to the plug-in compression profile file.

decode

Full path to the decompression directive file.

decodesetup

Full path to the plug-in decompression profile file.

For custom plug-in defined archive functions, lpParam1 indicates the full path to the custom tool directive file.

lpParam2

[in] Pointer to a null-terminated string that specifies the second function parameter. This parameter has meaning that changes according to the value of the lpFunction parameter.

For standard Codex defined archive functions:

Function

Parameter 2 Meaning

info

Not used.

encode

Full path to the plug-in compression profile file.

encodesetup

Not used.

decode

Full path to the plug-in decompression profile file.

decodesetup

Not used.

For custom plug-in defined archive functions, lpParam2 is not used.

Return Values

This function does not return any values.

Remarks

The plug-in should perform the function indicated in the lpFunction parameter. During this process, the plug-in is wholly responsible for displaying all function progress indicators, handling all user interaction, and also possibly handling errors that may occur.

The plug-in must display a progress dialog box with information about the current status of the desired function.

The plug-in, for its custom defined archive functions, may display a custom dialog box to further interact with the user about the custom action. For instance, if the plug-in supports editing archive comments, the plug-on may display an "Edit Archive Comments" dialog box with an edit field to type the archive comments and an OK button to apply the comments to the archive.

Requirements

Windows NT/2000/XP: Requires Windows NT 4.0 SP4 or later.
Windows 95/98/Me:
Requires Windows 98 (or Windows 95 with DCOM 1.2).
Header:
Declared in mCodexAPI.h.
Library:
Use mCodexAPI.dll.

See Also

SDK Overview, Plug-In Features, Plug-In Registration, Compression Directive File, Decompression Directive File, Custom Tool Directive File