Método IPortableDevicePropertiesBulk::QueueGetValuesByObjectFormat (portabledeviceapi.h)
La interfaz QueueGetValuesByObjectFormat pone en cola una solicitud de propiedades de objetos de un formato específico en un dispositivo.
Sintaxis
HRESULT QueueGetValuesByObjectFormat(
[in] REFGUID pguidObjectFormat,
[in] LPCWSTR pszParentObjectID,
[in] const DWORD dwDepth,
[in] IPortableDeviceKeyCollection *pKeys,
[in] IPortableDevicePropertiesBulkCallback *pCallback,
[out] GUID *pContext
);
Parámetros
[in] pguidObjectFormat
Puntero a un GUID que especifica el formato de objeto. Solo se consultan los objetos de este tipo.
[in] pszParentObjectID
Puntero a una cadena terminada en null que contiene el identificador de objeto del objeto primario donde debe comenzar la búsqueda. Para buscar en todos los objetos de un dispositivo, especifique WPD_DEVICE_OBJECT_ID.
[in] dwDepth
Profundidad máxima que se va a buscar por debajo del elemento primario, donde 1 significa solo elementos secundarios inmediatos. Es aceptable que este número sea mayor que el número real de niveles. Para buscar en cualquier profundidad, especifique 0xFFFFFFFF
[in] pKeys
Puntero a una interfaz IPortableDeviceKeyCollection que contiene las propiedades que se van a recuperar. Para obtener una lista de las propiedades definidas por dispositivos portátiles de Windows, vea Propiedades y atributos. Especifique NULL para indicar todas las propiedades del formato especificado.
[in] pCallback
Puntero a una interfaz IPortableDevicePropertiesBulkCallback implementada por la aplicación que recibirá la información a medida que se recupera.
[out] pContext
Puntero a un GUID que se usará para iniciar, cancelar o identificar la solicitud en devoluciones de llamada IPortableDevicePropertiesBulkCallback , si se implementa.
Valor devuelto
El método devuelve un valor HRESULT. Entre los valores posibles se incluyen los que se indican en la tabla siguiente, entre otros.
Código devuelto | Descripción |
---|---|
|
La operación se puso en cola correctamente. |
Comentarios
Si especifica WPD_OBJECT_FORMAT_ALL para el parámetro pguidObjectFormat , este método devolverá propiedades para todos los objetos del dispositivo.
Si el parámetro pszParentObjectID se establece en una cadena vacía (""), el método realizará una búsqueda que depende del parámetro dwDepth , como se describe en la tabla siguiente.
dwDepth | Devuelve el método |
0 | No hay resultados |
1 | Valores solo para el dispositivo especificado. |
2 | Valores para el dispositivo especificado y todos los objetos funcionales que se encuentran en ese dispositivo. |
Si el parámetro pszParentObjectID se establece en WPD_DEVICE_OBJECT_ID, el método realizará una búsqueda que depende del parámetro dwDepth , como se describe en la tabla siguiente.
dwDepth | Devuelve el método |
0 | Valores solo para el dispositivo especificado. |
1 | Valores para el dispositivo especificado y todos los objetos funcionales que se encuentran en ese dispositivo. |
La solicitud en cola no se inicia hasta que la aplicación llama a Start. Para obtener más información sobre cómo usar este método, vea IPortableDevicePropertiesBulk Interface.
Debido a problemas de rendimiento, es posible que algunos dispositivos no devuelvan una lista completa de propiedades cuando el parámetro pKeys es NULL.
Requisitos
Requisito | Value |
---|---|
Plataforma de destino | Windows |
Encabezado | portabledeviceapi.h |
Library | PortableDeviceGUIDs.lib |