Méthode IPart ::GetGlobalId (devicetopology.h)

La méthode GetGlobalId obtient l’ID global de cette partie.

Syntaxe

HRESULT GetGlobalId(
  [out] LPWSTR *ppwstrGlobalId
);

Paramètres

[out] ppwstrGlobalId

Pointeur vers une variable de pointeur dans laquelle la méthode écrit l’adresse d’une chaîne de caractères larges terminée par null qui contient l’ID global. La méthode alloue le stockage pour la chaîne. L’appelant est chargé de libérer le stockage, lorsqu’il n’est plus nécessaire, en appelant la fonction CoTaskMemFree . Si l’appel GetGlobalId échoue, *ppwstrGlobalId a la valeur NULL. Pour plus d’informations sur CoTaskMemFree, consultez la documentation du Kit de développement logiciel (SDK) Windows.

Valeur retournée

Si la méthode réussit, retourne S_OK. En cas d’échec, les codes de retour possibles incluent, sans s’y limiter, les valeurs indiquées dans le tableau suivant.

Code de retour	Description
E_POINTER	Le pointeur ppwstrGlobalId a la valeur NULL.
E_OUTOFMEMORY	Mémoire insuffisante.

Remarques

Un ID global est une chaîne qui identifie de manière unique une partie parmi toutes les parties de toutes les topologies d’appareils du système. Les clients doivent traiter cette chaîne comme opaque. Autrement dit, les clients ne doivent pas essayer d’analyser le contenu de la chaîne pour obtenir des informations sur la partie. La raison en est que le format de chaîne n’est pas défini et peut changer d’une implémentation de l’API DeviceTopology à la suivante.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	devicetopology.h

Voir aussi

IPart, interface