Export (0) Print
Expand All

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 REF StopFileName,
  [in]   string StartFileName,
  [in]   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]

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]

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.

Return valueDescription
0

Success.

2

Access denied.

8

Unspecified failure.

9

Invalid object.

10

Object already exists.

11

File system not NTFS.

12

Platform not Windows.

13

Drive not the same.

14

Directory not empty.

15

Sharing violation.

16

Invalid start file.

17

Privilege not held.

21

Invalid parameter.

 

Remarks

This method is currently not implemented by WMI. To use this method, you must implement it in your own provider.

Examples

For script code examples, see WMI Tasks for Scripts and Applications and the TechNet ScriptCenter Script Repository.

For C++ code examples, see WMI C++ Application Examples.

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows Server 2003

Namespace

\root\CIMV2

MOF

CIMWin32.mof

DLL

CIMWin32.dll

See also

CIM_LogicalFile
CIM_LogicalFile

 

 

Show:
© 2014 Microsoft