Msvm_CopyFileToGuestSettingData class

Represents the parameters for copying a file from the host into the guest. This class derives from CIM_SettingData.

The following syntax is simplified from MOF code and includes all inherited properties.

Syntax

[AMENDMENT]
class Msvm_CopyFileToGuestSettingData : CIM_SettingData
{
  string  Description;
  string  Caption;
  string  InstanceID;
  string  ElementName;
  boolean OverwriteExisting;
  boolean CreateFullPath;
  string  SourcePath;
  string  DestinationPath;
};

Members

The Msvm_CopyFileToGuestSettingData class has these types of members:

• Properties

Properties

The Msvm_CopyFileToGuestSettingData class has these properties.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen ( 64 )

A short textual description of the object.

CreateFullPath

Data type: boolean

Access type: Read-only

Indicates whether missing directories in the destination file's path must be created before copying the file.

Description

Data type: string

Access type: Read-only

A textual description of the object.

DestinationPath

Data type: string

Access type: Read-only

The complete path of the destination file to be copied. This destination file must be accessible to the guest and can contain environment variables, which are expanded by the guest. If the path specified is an existing directory in the guest, the destination file is created in this directory. In this case, the file name from SourcePath is used as the destination file name.

ElementName

Data type: string

Access type: Read-only

The display name for this instance of SettingData. In addition, the display name can be used as an index property for a search or query. (Note: The name does not have to be unique within a namespace.)

InstanceID

Data type: string

Access type: Read-only

Qualifiers: Key

Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm: OrgID:LocalID Where OrgID and LocalID are separated by a colon (:), and where OrgID must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the SchemaName_ClassName structure of Schema class names.) In addition, to ensure uniqueness, OrgID must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between OrgID and LocalID. LocalID is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If the above preferred algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. For DMTF-defined instances, the "preferred" algorithm must be used with the OrgID set to CIM.

OverwriteExisting

Data type: boolean

Access type: Read-only

Indicates whether an existing destination file must be overwritten.

SourcePath

Data type: string

Access type: Read-only

The complete path of the source file to be copied. This source file must be accessible to the Hyper-V host and can contain environment variables, which are expanded by the Hyper-V host.

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

CIM_SettingData

CIM_SettingData