Méthode IPortableDevicePropertiesBulk ::QueueGetValuesByObjectFormat (portabledeviceapi.h)

Article
03/01/2024

L’interface QueueGetValuesByObjectFormat met en file d’attente une demande de propriétés d’objets d’un format spécifique sur un appareil.

Syntaxe

HRESULT QueueGetValuesByObjectFormat(
  [in]  REFGUID                               pguidObjectFormat,
  [in]  LPCWSTR                               pszParentObjectID,
  [in]  const DWORD                           dwDepth,
  [in]  IPortableDeviceKeyCollection          *pKeys,
  [in]  IPortableDevicePropertiesBulkCallback *pCallback,
  [out] GUID                                  *pContext
);

Paramètres

[in] pguidObjectFormat

Pointeur vers un GUID qui spécifie le format de l’objet. Seuls les objets de ce type sont interrogés.

[in] pszParentObjectID

Pointeur vers une chaîne terminée par null qui contient l’ID d’objet de l’objet parent où la recherche doit commencer. Pour rechercher tous les objets d’un appareil, spécifiez WPD_DEVICE_OBJECT_ID.

[in] dwDepth

Profondeur maximale à rechercher sous le parent, où 1 signifie enfants immédiats uniquement. Il est acceptable que ce nombre soit supérieur au nombre réel de niveaux. Pour effectuer une recherche en profondeur, spécifiez 0xFFFFFFFF

[in] pKeys

Pointeur vers une interface IPortableDeviceKeyCollection qui contient les propriétés à récupérer. Pour obtenir la liste des propriétés définies par les appareils portables Windows, consultez Propriétés et attributs. Spécifiez NULL pour indiquer toutes les propriétés du format spécifié.

[in] pCallback

Pointeur vers une interface IPortableDevicePropertiesBulkCallback implémentée par l’application qui recevra les informations au fur et à mesure qu’elles seront récupérées.

[out] pContext

Pointeur vers un GUID qui sera utilisé pour démarrer, annuler ou identifier la requête dans les rappels IPortableDevicePropertiesBulkCallback , s’il est implémenté.

Valeur retournée

Cette méthode retourne un code HRESULT. Les valeurs possibles sont notamment celles figurant dans le tableau suivant.

Code de retour	Description
S_OK	L’opération a été mise en file d’attente avec succès.

Remarques

Si vous spécifiez WPD_OBJECT_FORMAT_ALL pour le paramètre pguidObjectFormat , cette méthode retourne des propriétés pour tous les objets sur l’appareil.

Si le paramètre pszParentObjectID est défini sur une chaîne vide (« »), la méthode effectue une recherche qui dépend du paramètre dwDepth , comme décrit dans le tableau suivant.

dwDepth	La méthode retourne
0	Aucun résultat
1	Valeurs pour l’appareil spécifié uniquement.
2	Valeurs de l’appareil spécifié et de tous les objets fonctionnels trouvés sur cet appareil.

Si le paramètre pszParentObjectID a la valeur WPD_DEVICE_OBJECT_ID, la méthode effectue une recherche qui dépend du paramètre dwDepth , comme décrit dans le tableau suivant.

dwDepth	La méthode retourne
0	Valeurs pour l’appareil spécifié uniquement.
1	Valeurs de l’appareil spécifié et de tous les objets fonctionnels trouvés sur cet appareil.

La requête mise en file d’attente n’est pas démarrée tant que l’application n’appelle pas Start. Pour plus d’informations sur l’utilisation de cette méthode, consultez IPortableDevicePropertiesBulk Interface.

En raison de problèmes de performances, certains appareils peuvent ne pas renvoyer une liste complète de propriétés lorsque le paramètre pKeys a la valeur NULL.

Configuration requise

Condition requise	Valeur
Plateforme cible	Windows
En-tête	portabledeviceapi.h
Bibliothèque	PortableDeviceGUIDs.lib

Voir aussi

IPortableDevicePropertiesBulk, interface

Partager via