CompressEx method of the Win32_CodecFile class

The CompressEx WMI class method compresses the logical codec file (or directory) specified in the object path (this method is an extended version of the Compress method).

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 CompressEx method failed. This parameter will be null if the method succeeds.

StartFileName [in, optional]

Names the child file or directory to use as a starting point for CompressEx .The StartFileName parameter is typically 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 change of ownership will be applied recursively to files and directories within the directory specified by the CIM_LogicalFile instance. Note: for file instances, the Recursive input parameter is ignored.

Return value

Returns an value of 0 (zero) if the file was successfully compressed, and any other number to indicate an error.

0

The request was successful.

2

Access was denied.

8

An unspecified failure occurred.

9

The name specified was not valid.

10

The object specified already exists.

11

The file system is not NTFS.

12

The platform is not Windows.

13

The drive is not the same.

14

The directory is not empty.

15

There has been a sharing violation.

16

The start file specified was not valid.

17

A privilege required for the operation is not held.

21

A parameter specified is not valid.

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2008

Namespace

Root\CIMV2

MOF

CIMWin32.mof

DLL

CIMWin32.dll

See also

Operating System Classes
Win32_CodecFile

 

 

Show: