Win32_ShortcutAction class
The Win32_ShortcutAction WMI class manages the creation of shortcuts. In the Advertise mode, the action creates shortcuts to the key files of components of features that are enabled. Advertised shortcuts are those for which the Target property is the feature of the component and the directory of the shortcut is one of the Shell folders or below one. Advertised shortcuts are created with a Microsoft installer technology Descriptor as the target.
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_ShortcutAction : CIM_Action
{
string ActionID;
string Arguments;
string Caption;
string Description;
uint16 Direction;
uint16 HotKey;
string IconIndex;
string Name;
string Shortcut;
uint16 ShowCmd;
string SoftwareElementID;
uint16 SoftwareElementState;
string Target;
uint16 TargetOperatingSystem;
string Version;
string WkDir;
};
Members
The Win32_ShortcutAction class has these types of members:
- Methods
- Properties
Methods
The Win32_ShortcutAction 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_ShortcutAction class has these properties.
ActionID
Data type: string
Access type: Read-only
Unique identifier assigned to a particular action for a software element.
Arguments
Data type: string
Access type: Read-only
Command-line arguments for the shortcut.
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
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 |
HotKey
Data type: uint16
Access type: Read-only
Hot key for the shortcut. It has the virtual-key code for the key in the low-order byte, and the modifier flags in the high-order byte.
IconIndex
Data type: string
Access type: Read-only
Icon index for the shortcut.
Name
Data type: string
Access type: Read-only
Name used to identify the software element.
Shortcut
Data type: string
Access type: Read-only
Name of the shortcut to be created.
ShowCmd
Data type: uint16
Access type: Read-only
View state of the application window (similar to the ShowWindow Windows function).
| Value | Meaning |
|---|---|
| 0 | SW_SHOWNORMAL |
| 3 | SW_SHOWMAXIMIZED |
| 7 | SW_SHOWMINNOACTIVE |
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 |
Target
Data type: string
Access type: Read-only
Shortcut target specifies the action to be taken when a shortcut is launched. This can reference a software feature, file specification, or directory specification.
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 of the software element. Values should be in the form [Major].[Minor].[Revision] or [Major].[Minor][letter][revision].
WkDir
Data type: string
Access type: Read-only
Name of the Win32_Property instance that has the path of the working directory for the shortcut.
Remarks
Non-advertised shortcuts are those for which the Target property in the Win32_ShortcutAction class is a property or the directory of the shortcut is not one of the Shell folders or below one. In the non-advertise mode (normal install), the action creates shortcuts to the key files of components of features that are selected for installation as well as non-advertised shortcuts whose component is selected for installation.
The Win32_ShortcutAction class is derived from CIM_Action.
Requirements
Minimum supported client |
Windows XP |
Minimum supported server |
Windows Server 2003 |
Namespace |
Root\CIMV2 |
MOF |
Msi.mof |
DLL |
Msiprov.dll |