Fonction IoGetDeviceInterfacePropertyData (wdm.h)

  • Article

La routine IoGetDeviceInterfacePropertyData récupère la valeur actuelle d’une propriété d’interface d’appareil.

Syntaxe

NTSTATUS IoGetDeviceInterfacePropertyData(
  [in]  PUNICODE_STRING  SymbolicLinkName,
  [in]  const DEVPROPKEY *PropertyKey,
  [in]  LCID             Lcid,
        ULONG            Flags,
  [in]  ULONG            Size,
  [out] PVOID            Data,
  [out] PULONG           RequiredSize,
  [out] PDEVPROPTYPE     Type
);

Paramètres

[in] SymbolicLinkName

Pointeur vers une chaîne qui identifie l’interface de l’appareil instance. Cette chaîne a été obtenue à partir d’un appel précédent à la routine IoGetDeviceInterfaces, IoGetDeviceInterfaceAlias ou IoRegisterDeviceInterface .

[in] PropertyKey

Pointeur vers une structure DEVPROPKEY qui contient la clé de propriété de l’interface d’appareil.

[in] Lcid

Spécifie un identificateur de paramètres régionaux. Définissez ce paramètre sur une valeur LCID spécifique au langage ou sur LOCALE_NEUTRAL. L’LOCALE_NEUTRAL LCID spécifie que la propriété n’est pas linguistique (c’est-à-dire qu’elle n’est spécifique à aucune langue). Ne définissez pas ce paramètre sur LOCALE_SYSTEM_DEFAULT ou LOCALE_USER_DEFAULT. Pour plus d’informations sur les valeurs LCID spécifiques à la langue, consultez Structure LCID.

Flags

Réservé pour le système. Les pilotes doivent définir cette valeur sur zéro.

[in] Size

Spécifie la taille, en octets, de la mémoire tampon vers laquelle les données pointent.

[out] Data

Pointeur vers une mémoire tampon allouée à l’appelant dans laquelle la routine écrit les données de propriété de l’interface de l’appareil.

[out] RequiredSize

Pointeur vers une variable ULONG dans laquelle IoGetDeviceInterfacePropertyData écrit la taille requise des données de propriété. Si la routine réussit, la valeur de taille requise est le nombre d’octets que la routine écrit dans la mémoire tampon de sortie vers laquelle pointe Data . Si la routine retourne STATUS_BUFFER_TOO_SMALL, la valeur de taille requise est la taille de la mémoire tampon que l’appelant doit allouer pour cette valeur de propriété.

[out] Type

Pointeur vers une variable DEVPROPTYPE . Si IoGetDeviceInterfacePropertyData récupère correctement les données de propriété, la routine écrit la valeur du type de propriété dans cette variable. Cette valeur indique le type de données de propriété qui se trouve dans la mémoire tampon de données .

Valeur retournée

IoGetDeviceInterfacePropertyData retourne STATUS_SUCCESS si elle réussit. Les valeurs de retour d’erreur possibles incluent les codes status suivants.

Code de retour Description
STATUS_BUFFER_TOO_SMALL La mémoire tampon vers laquelle pointe Data est trop petite pour contenir les données de propriété. *RequiredSize contient la longueur de mémoire tampon requise.
STATUS_UNSUCCESSFUL La valeur LCID spécifiée n’est pas valide.
STATUS_NOT_IMPLEMENTED La propriété spécifiée n’est pas prise en charge.

Remarques

Les pilotes en mode noyau utilisent la routine IoGetDeviceInterfacePropertyData pour récupérer les propriétés d’interface d’appareil définies dans le cadre du modèle de propriété d’appareil unifié. Pour plus d’informations sur les propriétés de l’interface de l’appareil, consultez Propriétés de l’appareil.

Les pilotes peuvent utiliser la routine IoSetDeviceInterfacePropertyData pour modifier une propriété d’interface d’appareil.

Les appelants d’IoGetDeviceInterfacePropertyData doivent s’exécuter à IRQL = PASSIVE_LEVEL dans le contexte d’un thread système.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Disponible dans Windows 8 et versions ultérieures de Windows.
Plateforme cible Universal
En-tête wdm.h (inclure Wdm.h, Ntddk.h, Ntifs.h)
Bibliothèque NtosKrnl.lib
DLL NtosKrnl.exe
IRQL PASSIVE_LEVEL

Voir aussi

DEVPROPKEY

DEVPROPTYPE

IoSetDeviceInterfacePropertyData