CompressEx method of the CIM_LogicalFile class
The CompressEx method compresses the logical file (or directory) specified in the object path. This method is an extended version of the Compress method.
Important
The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.
This topic uses Managed Object Format (MOF) syntax. For more information about using this method, see Calling a Method.
Syntax
uint32 CompressEx(
[out] string StopFileName,
[in, optional] string StartFileName,
[in, optional] boolean Recursive
);
Parameters
-
StopFileName [out]
-
Name of the file (or directory) where the method failed. This parameter is null if the method succeeds.
-
StartFileName [in, optional]
-
Child file (or directory) to use as a starting point for the method. Typically, this parameter is the StopFileName parameter specifying the file or directory at which an error occurred from the previous method call. If this parameter is null, the operation is performed on the file (or directory) specified in the ExecMethod call.
-
Recursive [in, optional]
-
If TRUE, the method is also applied recursively to files and directories within the directory specified by the CIM_LogicalFile instance. For file instances, this parameter is ignored.
Return value
Returns a value of 0 (zero) on success, and any other number to indicate an error.
-
Success
-
0
Success.
-
Access Denied
-
2
Access denied.
-
Unspecified failure
-
8
Unspecified failure.
-
Invalid object
-
9
Invalid object.
-
Object already exists
-
10
Object already exists.
-
File system not NTFS
-
11
File system not NTFS.
-
Platform not NT/Windows 2000
-
12
Platform not Windows.
-
Drive not the same
-
13
Drive not the same.
-
Directory not empty
-
14
Directory not empty.
-
Sharing violation
-
15
Sharing violation.
-
Invalid start file
-
16
Invalid start file.
-
Privilege not held
-
17
Privilege not held.
-
Invalid parameter
-
21
Invalid parameter.
Remarks
This method is currently not implemented by WMI. To use this method, you must implement it in your own provider.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows Vista |
| Minimum supported server |
Windows Server 2008 |
| Namespace |
Root\CIMV2 |
| MOF |
|
| DLL |
|