Win32_RemoveFileAction class

  • Article

The Win32_RemoveFileAction WMI class represents files previously installed which are to be removed. The class can also remove specific author-specified files that were not installed by the installer. Each of these files is gated by a link to an entry in the software element class; those files whose components are resolved to any active Action state (that is, not in the off or NULL state) are removed if the file exists in the specified directory. This implies that removal of files is attempted when the gating software element is first installed, during a reinstall, and again when the gating software element is removed.

Note

For more information about support or requirements for installation on a specific operating system, see Operating System Availability of WMI Components.

The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties. Properties and methods are in alphabetic order, not MOF order.

Syntax

[Provider("MSIProv"), Dynamic]
class Win32_RemoveFileAction : CIM_RemoveFileAction
{
  string ActionID;
  string Caption;
  string Description;
  uint16 Direction;
  string DirProperty;
  string File;
  string FileKey;
  string FileName;
  uint16 InstallMode;
  string Name;
  string SoftwareElementID;
  uint16 SoftwareElementState;
  uint16 TargetOperatingSystem;
  string Version;
};

Members

The Win32_RemoveFileAction class has these types of members:

Methods

The Win32_RemoveFileAction class has these methods.

Method Description
Invoke Takes a particular action. The details of how the method performs the action are implementation-specific.

Properties

The Win32_RemoveFileAction class has these properties.

ActionID

Data type: string

Access type: Read-only

Unique identifier assigned to a particular action for a software element.

Caption

Data type: string

Access type: Read-only

Short textual description of the object.

Description

Data type: string

Access type: Read-only

Description of the object.

Direction

Data type: uint16

Access type: Read-only

Whether a particular CIM_Action object is part of a sequence of actions to transition the current software element to its next state (Install) or to remove the current software element (Uninstall).

Value Meaning
1
 Install
2
 Uninstall

DirProperty

Data type: string

Access type: Read-only

Win32_Property instance whose value is assumed to resolve to the full path to the folder of the file to be removed. The property can be the name of a directory property for a Win32_DirectorySpecification instance or any other property that represents a full path.

File

Data type: string

Access type: Read-only

File name.

FileKey

Data type: string

Access type: Read-only

Unique key identifying this remove file action within its product.

FileName

Data type: string

Access type: Read-only

Name of the file to be removed. If this column is NULL, then the specified folder is removed if it is empty. All of the files that match the wildcard are removed from the specified directory.

InstallMode

Data type: uint16

Access type: Read-only

Bitmap that identifies when this remove file action is performed.

Value Meaning
0x001 (1)
 Remove only when the associated component is being installed (msiInstallStateLocal or msiInstallStateSource).
0x002 (2)
 Remove only when the associated component is being removed (msiInstallStateAbsent)
0x003 (3)
 Remove in either of the above cases.

Name

Data type: string

Access type: Read-only

Name used to identify the software element.

SoftwareElementID

Data type: string

Access type: Read-only

Identifier for the software element.

SoftwareElementState

Data type: uint16

Access type: Read-only

State of a software element.

Value Meaning
1
 Deployable
2
 Installable
3
 Executable
4
 Running

TargetOperatingSystem

Data type: uint16

Access type: Read-only

Target operating system of the owning software element. The possible values for this property are as follows.

Value Meaning
0
 Unknown
1
 Other
2
 MACOS
3
 ATTUNIX
4
 DGUX
5
 DECNT
6
 Digital Unix
7
 OpenVMS
8
 HPUX
9
 AIX
10
 MVS
11
 OS400
12
 OS/2
13
 JavaVM
14
 MSDOS
15
 WIN3x
16
 WIN95
17
 WIN98
18
 WINNT
19
 WINCE
20
 NCR3000
21
 NetWare
22
 OSF
23
 DC/OS
24
 Reliant UNIX
25
 SCO UnixWare
26
 SCO OpenServer
27
 Sequent
28
 IRIX
29
 Solaris
30
 SunOS
31
 U6000
32
 ASERIES
33
 TandemNSK
34
 TandemNT
35
 BS2000
36
 LINUX
37
 Lynx
38
 XENIX
39
 VM/ESA
40
 Interactive UNIX
41
 BSDUNIX
42
 FreeBSD
43
 NetBSD
44
 GNU Hurd
45
 OS9
46
 MACH Kernel
47
 Inferno
48
 QNX
49
 EPOC
50
 IxWorks
51
 VxWorks
52
 MiNT
53
 BeOS
54
 HP MPE
55
 NextStep
56
 PalmPilot
57
 Rhapsody

Version

Data type: string

Access type: Read-only

Version should be in the form [Major].[Minor].[Revision] or [Major].[Minor][letter][revision].

Remarks

The Win32_RemoveFileAction class is derived from CIM_RemoveFileAction.

Requirements
Minimum supported client
 Windows XP
Minimum supported server
 Windows Server 2003
Namespace
 Root\CIMV2
MOF
Msi.mof
DLL
Msiprov.dll

See also

Installed Applications Classes