IVMVirtualMachine::GetConfigurationValue, méthode

Article
06/13/2023

[Windows Virtual PC n’est plus disponible depuis Windows 8. Utilisez plutôt le fournisseur WMI Hyper-V (V2).]

Récupère la valeur du paramètre de configuration spécifié pour cette machine virtuelle.

Syntaxe

HRESULT GetConfigurationValue(
  [in]          BSTR    configurationKey,
  [out, retval] VARIANT *configurationValue
);

Paramètres

configurationKey [in]: Clé utilisée pour identifier la valeur de configuration telle qu’elle est stockée dans le fichier « *.vmc ».
configurationValue [out, retval]: Valeur de configuration. Cette valeur peut être l’un des types VARIANT suivants : VT_ARRAY|VT_UI1 (octets bruts), VT_BSTR (chaîne), VT_I4 (entier) ou VT_BOOL (booléen).

Valeur retournée

Cette méthode peut retourner l’une de ces valeurs.

Code/valeur de retour	Description
S_OK 0	L'opération a réussi.
E_INVALIDARG 0x80000003	Le paramètre configurationKey est NULL ou vide.
E_POINTER 0x80004003	Le paramètre configurationValue est NULL.
VM_E_VM_UNKNOWN 0xA0040207	La configuration est inconnue.
VM_E_PREF_NOT_FOUND 0xA0040300	La préférence est introuvable.
DISP_E_EXCEPTION 0x80020009	Une erreur inattendue s’est produite.

Notes

Cette méthode fournit un accès de bas niveau à n’importe quelle valeur de configuration. Il peut être utilisé pour lire les valeurs de configuration des clés définies par le client.

Les clés de configuration se trouvent dans le fichier « *.vmc » de la machine virtuelle au format XML. Les clés sont stockées de manière hiérarchique similaire aux clés de Registre dans Windows. Pour spécifier une sous-clé spécifique, un « chemin de clé » est construit qui spécifie les différentes clés dans un format délimité par une barre oblique.

Par exemple, pour lire la valeur de la clé « ram_size » située dans l’arborescence de clés suivante :

<hardware>
    <memory>
        <ram_size type="integer">128</ram_size>

La chaîne de chemin d’accès configurationKey est spécifiée comme suit :

"hardware/memory/ram_size"

Si l’une des clés de l’arborescence souhaitée a une valeur d’attribut « id », l’attribut et sa valeur sont incorporés dans la chaîne de chemin d’accès configurationKey immédiatement après sa clé de configuration associée au format entre crochets suivant : « [@id="id_value"] ».

Par exemple, pour lire la valeur de la clé « absolute » située dans l’arborescence de clés suivante :

<hardware>
    <pci_bus>
        <ide_adapter>
            <ide_controller id="1">
                <location id="0">
                    <pathname>
                        <absolute type="string">D</absolute>

La chaîne de chemin d’accès configurationKey est spécifiée comme suit :

"hardware/pci_bus/ide_adapter/ide_controller[@id=1]/location[@id=0]/pathname/absolute"

Spécifications

Condition requise	Valeur
Client minimal pris en charge	Windows 7 [applications de bureau uniquement]
Serveur minimal pris en charge	Aucun pris en charge
Fin de la prise en charge des clients	Windows 7
Produit	Windows Virtual PC
En-tête	VPCCOMInterfaces.h
IID	IID_IVMVirtualMachine est défini comme f7092aa1-33ed-4f78-a59f-c00adfc2edd7

Voir aussi

IVMVirtualMachine

Partager via