Codex API: Profiles

EditCompressionProfile

The EditCompressionProfile starts the plug-in defined profile editor for a new or existing compression profile over the given archive.

 

VOID EditCompressionProfile(
    LPCTSTR lpArchive,        // archive format
    LPCTSTR lpProfile,        // profile to edit
);

Parameters

lpArchive

[in] Pointer to a null-terminated string that specifies the archive to which the profile belongs.

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

lpProfile

[in] Pointer to a null-terminated string that identifies the profile to be edited.

You may use the GetCompressionProfilesEx function to obtain a list of existing profiles.

To create a new profile, pass a new profile name in this parameter. You should not use the values "Default", "Structured" or "Shell" when creating new profiles.

Return Values

This function does not return any values.

Remarks

This function starts the plug-in defined profile editor and immediately returns without waiting for the profile editor to close.

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

Codex API Overview, Codex API Functions, GetCompressionProfilesEx