Compartilhar via

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

  • Artigo

A interface QueueGetValuesByObjectFormat enfileira uma solicitação de propriedades de objetos de um formato específico em um dispositivo.

Sintaxe

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

Ponteiro para um GUID que especifica o formato do objeto. Somente objetos desse tipo são consultados.

[in] pszParentObjectID

Ponteiro para uma cadeia de caracteres terminada em nulo que contém a ID do objeto pai em que a pesquisa deve começar. Para pesquisar todos os objetos em um dispositivo, especifique WPD_DEVICE_OBJECT_ID.

[in] dwDepth

A profundidade máxima a ser pesquisada abaixo do pai, em que 1 significa somente filhos imediatos. É aceitável que esse número seja maior que o número real de níveis. Para pesquisar em qualquer profundidade, especifique 0xFFFFFFFF

[in] pKeys

Ponteiro para uma interface IPortableDeviceKeyCollection que contém as propriedades a serem recuperadas. Para obter uma lista de propriedades definidas por Dispositivos Portáteis do Windows, consulte Propriedades e Atributos. Especifique NULL para indicar todas as propriedades do formato especificado.

[in] pCallback

Ponteiro para uma interface IPortableDevicePropertiesBulkCallback implementada pelo aplicativo que receberá as informações conforme elas forem recuperadas.

[out] pContext

Ponteiro para um GUID que será usado para iniciar, cancelar ou identificar a solicitação em retornos de chamada IPortableDevicePropertiesBulkCallback , se implementado.

Retornar valor

O método retorna um HRESULT. Os possíveis valores incluem, mas sem limitação, aqueles na tabela a seguir.

Código de retorno Descrição
S_OK
 A operação foi enfileirada com êxito.

Comentários

Se você especificar WPD_OBJECT_FORMAT_ALL para o parâmetro pguidObjectFormat , esse método retornará propriedades para todos os objetos no dispositivo.

Se o parâmetro pszParentObjectID estiver definido como uma cadeia de caracteres vazia (""), o método executará uma pesquisa que depende do parâmetro dwDepth , conforme descrito na tabela a seguir.

dwDepth Método retorna
0 Sem resultados
1 Valores somente para o dispositivo especificado.
2 Valores para o dispositivo especificado e todos os objetos funcionais encontrados nesse dispositivo.
 

Se o parâmetro pszParentObjectID estiver definido como WPD_DEVICE_OBJECT_ID, o método executará uma pesquisa que depende do parâmetro dwDepth , conforme descrito na tabela a seguir.

dwDepth Método retorna
0 Valores somente para o dispositivo especificado.
1 Valores para o dispositivo especificado e todos os objetos funcionais encontrados nesse dispositivo.
 

A solicitação enfileirada não é iniciada até que o aplicativo chame Iniciar. Para obter mais informações sobre como usar esse método, consulte Interface IPortableDevicePropertiesBulk.

Devido a problemas de desempenho, alguns dispositivos podem não retornar uma lista abrangente de propriedades quando o parâmetro pKeys for NULL.

Requisitos

Requisito Valor
Plataforma de Destino Windows
Cabeçalho portabledeviceapi.h
Biblioteca PortableDeviceGUIDs.lib

Confira também

IPortableDevicePropertiesBulk Interface