Codex API: Profiles


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


INT GetCompressionProfilesEx(
    LPCTSTR lpArchive,         // archive format
    LPTSTR lpProfiles          // compression profiles



[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 GetCompressibleArchivesEx function to obtain the list of archives supported for compression.


[out] Pointer to a buffer that receives the list of all available compression profiles formatted as COMMATEXT.

Pass NULL in this parameter to request the required size for the buffer.

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 EditCompressionProfile function. You should not create profiles named "Default", "Structured", "Shell" if they do not already exist.

You may delete existing profiles using the DeleteCompressionProfile 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.

Return Values

The return value specifies the required size of the buffer, excluding the number of bytes necessary for a terminating null character.


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, GetCompressibleArchivesEx, COMMATEXT