CompressEx method of the Win32_NTEventlogFile class

The CompressEx WMI class method uses NTFS compression to compress the logical file (or directory) specified in the Win32_NTEventlogFile.Name property (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 is 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 is 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

Requirements

See also

Operating System Classes

Win32_NTEventlogFile