Codex API: Profiles


The GetExtractionProfiles function obtains the list of plug-in defined data decompression settings stored as a collection of profiles.

Note This function is provided for backwards compatibility only. Newer applications should use the GetExtractionProfilesEx function.


LPCTSTR GetExtractionProfiles(
    LPCTSTR lpArchive           // archive format



[in] Pointer to a null-terminated string that specifies the archive for which profile information should be returned.

The lpArchive parameter must include the archive extension only. The extension may include wildcards.

Use the GetExtractableArchives function to obtain the list of archives supported for decompression.

Return Values

The function returns a list of all available profiles formatted as COMMATEXT.

Below is the list of standard Codex defined archive profiles: 




The default profile. This profile is guaranteed to exist if the archive operation is supported at all.


Internal Codex profile. This profile is used during the execution of Codex defined archive tools.


The shell profile. This profile is used during shell operations. For example, when the user right-clicks an archive in Windows Explorer and selects an archive action, the shell profile is used.

Other profiles may be provided by the plug-in supporting the archive. In this case, the profiles will carry meaningful names such as "Maximum Compression".

You may create new profiles using the EditExtractionProfile function. You should not create profiles named "Default", "Structured", "Shell" if they do not already exist.

You may delete existing profiles using the DeleteExtractionProfile function. You should not delete profiles named "Default", "Structured", "Shell" if they already exist.

An application is recommended to use the Default profile for most archive tasks.


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).
Declared in mCodexAPI.h.
Use mCodexAPI.dll.

See Also

Codex API Overview, Codex API Functions, GetExtractableArchives