WdfDeviceRetrieveDeviceName, fonction (wdfdevice.h)
[S’applique à KMDF uniquement]
La méthode WdfDeviceRetrieveDeviceName retourne le nom de l’appareil d’un appareil spécifié.
Syntaxe
NTSTATUS WdfDeviceRetrieveDeviceName(
[in] WDFDEVICE Device,
[in] WDFSTRING String
);
Paramètres
[in] Device
Handle pour un objet d’appareil d’infrastructure.
[in] String
Handle vers un objet de chaîne d’infrastructure qui reçoit le nom de l’appareil.
Valeur retournée
Si l’opération réussit, WdfDeviceRetrieveDeviceName retourne STATUS_SUCCESS. Les valeurs de retour supplémentaires sont les suivantes :
| Code de retour | Description |
|---|---|
|
Un paramètre non valide a été détecté. |
La méthode peut retourner d’autres valeurs NTSTATUS.
Un bogue case activée se produit si le pilote fournit un handle d’objet non valide.
Remarques
La méthode WdfDeviceRetrieveDeviceName retourne le nom de périphérique que le pilote a spécifié dans un appel précédent à WdfDeviceInitAssignName.
Pour obtenir la chaîne de nom d’appareil à partir de l’objet string, le pilote peut appeler WdfStringGetUnicodeString.
Exemples
L’exemple de code suivant crée un objet string, puis récupère le nom d’un appareil spécifié.
NTSTATUS status;
WDFSTRING string;
status = WdfStringCreate(
NULL,
WDF_NO_OBJECT_ATTRIBUTES,
&string
);
if (NT_SUCCESS(status)) {
status = WdfDeviceRetrieveDeviceName(
Device,
string
);
if (!NT_SUCCESS(status)) {
return status;
}
}
Configuration requise
| Condition requise | Valeur |
|---|---|
| Plateforme cible | Universal |
| Version KMDF minimale | 1.0 |
| En-tête | wdfdevice.h (inclure Wdf.h) |
| Bibliothèque | Wdf01000.sys (consultez Gestion des versions de la bibliothèque d’infrastructure).) |
| IRQL | PASSIVE_LEVEL |
| Règles de conformité DDI | DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf) |