InitiateShutdown method of the Msvm_ShutdownComponent class

Article
01/07/2021

Initiates an operating system shutdown operation on the associated child virtual machine. If zero (0) is returned, then the shutdown was initiated successfully. Any other return code indicates an error condition.

Syntax

uint32 InitiateShutdown(
  [in] boolean Force,
  [in] string  Reason
);

Parameters

Force [in]

Type: boolean

A flag which, if True, forces applications to be closed despite having unsaved data.

Reason [in]

Type: string

The reason for the shutdown operation. This is a user-defined string.

Return value

Type: uint32

Completed with No Error (0)
Method Parameters Checked - Job Started (4096)
Failed (32768)
Access Denied (32769)
Not Supported (32770)
Status is unknown (32771)
Timeout (32772)
Invalid parameter (32773)
System is in used (32774)
Invalid state for this operation (32775)
Incorrect data type (32776)
System is not available (32777)
Out of memory (32778)
File not found (32779)
The system is not ready (32780)
The machine is locked and cannot be shut down without the force option (32781)
A system shutdown is in progress (32782)

Remarks

Access to the Msvm_ShutdownComponent class might be restricted by UAC Filtering. For more information, see User Account Control and WMI.

Requirements

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Namespace	Root\Virtualization\V2
Header	Winreg.h
MOF	WindowsVirtualization.V2.mof
DLL	Vmms.exe