Represents a guest file service operation job. This class derives from Msvm_GuestFileService.
The following syntax is simplified from MOF code and includes all inherited properties.
Syntax
[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_CopyFileToGuestJob : CIM_ConcreteJob
{
string Caption;
string CreationClassName;
string Description;
datetime InstallDate;
string Name;
boolean Started;
string StartMode;
string Status;
string SystemCreationClassName;
string SystemName;
string CopyFileToGuestSettingData[];
boolean Cancellable;
string ErrorSummaryDescription;
string VirtualSystemName;
};
Members
The Msvm_CopyFileToGuestJob class has these types of members:
Methods
The Msvm_CopyFileToGuestJob class has these methods.
| Method | Description |
|---|---|
| CopyFilesToGuest | Copies files from the Hyper-V host to the virtual machine. |
| GetError | Retrieves the error object for the job. |
| GetErrorEx | Retrieves the error objects for the job. |
| RequestStateChange | Changes the state of the job. |
| StartService | This method is not supported. |
| StopService | This method is not supported. |
Properties
The Msvm_CopyFileToGuestJob class has these properties.
Cancellable
Data type: boolean
Access type: Read-only
Indicates whether the job can be cancelled. The value of this property does not guarantee that a request to cancel the job will succeed. If TRUE, the job can be cancelled; otherwise, FALSE.
Caption
Data type: string
Access type: Read-only
Short textual description of the object. This property is inherited from CIM_ManagedSystemElement.
CopyFileToGuestSettingData
Data type: string array
Access type: Read-only
Setting data that is used to copy a file.
CreationClassName
Data type: string
Access type: Read-only
Name of the class or subclass used in the creation of an instance. When used with other key properties of the class, this property allows all instances of the class and its subclasses to be uniquely identified.
Description
Data type: string
Access type: Read-only
Textual description of the object. This property is inherited from CIM_ManagedSystemElement.
ErrorSummaryDescription
Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_Job.ErrorCode")
A summary description of the error, if present. This property is inherited from CIM_Job.
InstallDate
Data type: datetime
Access type: Read-only
Date and time the object was installed. This property does not need a value to indicate that the object is installed. This property is inherited from CIM_ManagedSystemElement.
Name
Data type: string
Access type: Read-only
Unique identifier for the service that also provides an indication of the functionality that is managed. For more information about the functionality, see the object's Description property. This property is inherited from CIM_ManagedSystemElement.
Started
Data type: boolean
Access type: Read-only
If TRUE, the service has started.
StartMode
Data type: string
Access type: Read-only
Indicates whether the service is automatically started (for example, by an operating system) or only started upon request.
Values include the following:
"Automatic"
"Manual"
Status
Data type: string
Access type: Read-only
Current status of the object. This property is inherited from CIM_ManagedSystemElement.
Values include the following:
"OK"
"Error"
"Degraded"
"Unknown"
"Pred Fail"
"Starting"
"Stopping"
"Service"
"Stressed"
"NonRecover"
"No Contact"
"Lost Comm"
SystemCreationClassName
Data type: string
Access type: Read-only
Scoping system's creation class name.
SystemName
Data type: string
Access type: Read-only
Name of the system that hosts the service.
VirtualSystemName
Data type: string
Access type: Read-only
GUID of the affected virtual system.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 8.1 [desktop apps only] |
| Minimum supported server | Windows Server 2012 R2 [desktop apps only] |
| Namespace | Root\Virtualization\V2 |
| MOF | WindowsVirtualization.V2.mof |
| DLL | Vmms.exe |
See also
Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors. Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.
