Méthode IPort ::GetDeviceProperty (portcls.h)

La méthode GetDeviceProperty fournit un accès simplifié aux propriétés d’appareil contenues dans le Registre pour les appareils Plug-and-Play.

Syntaxe

NTSTATUS GetDeviceProperty(
  DEVICE_REGISTRY_PROPERTY DeviceProperty,
  ULONG                    BufferLength,
  PVOID                    PropertyBuffer,
  PULONG                   ResultLength
);

Paramètres

DeviceProperty

Identifie la propriété d’appareil particulière demandée par l’appelant. Les valeurs valides pour ce paramètre sont les mêmes que celles définies pour le paramètre DeviceProperty de l’appel IoGetDeviceProperty.

BufferLength

Spécifie la longueur en octets de la mémoire tampon qui doit recevoir les informations demandées.

PropertyBuffer

Pointeur vers la mémoire tampon de propriété. Ce paramètre pointe vers une mémoire tampon allouée à l’appelant dans laquelle la méthode écrit les informations de propriété demandées. La mémoire tampon doit être suffisamment grande pour contenir le nombre d’octets spécifié dans BufferLength.

ResultLength

Pointeur de sortie vers la longueur des données retournées. Ce paramètre pointe vers une variable ULONG allouée à l’appelant dans laquelle la méthode écrit un nombre spécifiant le nombre d’octets réellement écrits dans la mémoire tampon PropertyBuffer. Toutefois, si la mémoire tampon est trop petite pour contenir les informations, la méthode génère plutôt la taille de mémoire tampon requise.

Valeur retournée

Cette méthode retourne NTSTATUS qui contient STATUS_SUCCESS si l’appel a réussi. Sinon, la méthode retourne un code d’erreur approprié. Si la mémoire tampon de propriété fournie par l’appelant est trop petite, la méthode retourne STATUS_BUFFER_TOO_SMALL et génère la taille nécessaire dans ReturnLength.

Remarques

Cette méthode récupère les propriétés de l’appareil de l’adaptateur audio. Son fonctionnement est similaire à la fonction PcGetDeviceProperty, sauf qu’elle récupère automatiquement les propriétés de l’appareil de la carte audio au lieu de demander à un objet d’appareil de spécifier explicitement un appareil cible.

Configuration requise

Voir aussi

IPort