Método IWDFUsbTargetDevice::RetrieveDescriptor (wudfusb.h)

[Aviso: UMDF 2 é a versão mais recente do UMDF e substitui UMDF 1. Todos os novos drivers UMDF devem ser gravados usando UMDF 2. Nenhum novo recurso está sendo adicionado ao UMDF 1 e há suporte limitado para UMDF 1 em versões mais recentes do Windows 10. Drivers universais do Windows devem usar UMDF 2. Para obter mais informações, consulte Introdução com UMDF.]

O método RetrieveDescriptor recupera um descritor USB, que pode descrever um dispositivo, configuração ou cadeia de caracteres.

Sintaxe

HRESULT RetrieveDescriptor(
  [in]      UCHAR  DescriptorType,
  [in]      UCHAR  Index,
  [in]      USHORT LanguageID,
  [in, out] ULONG  *BufferLength,
  [out]     PVOID  Buffer
);

Parâmetros

[in] DescriptorType

Um valor que especifica o tipo de descritor a ser retornado. Esse parâmetro corresponde ao campo bDescriptorType de um descritor de dispositivo padrão, cujos valores são descritos na especificação do Barramento Serial Universal . (Esse recurso pode não estar disponível em alguns idiomas

e países.) Alguns desses valores são listados na descrição do membro DescriptorType da estrutura _URB_CONTROL_DESCRIPTOR_REQUEST .

[in] Index

O índice do descritor, de acordo com a especificação do Barramento Serial Universal . (Esse recurso pode não estar disponível em alguns idiomas

e países.)

[in] LanguageID

O identificador do idioma, se o driver UMDF solicitar um descritor de cadeia de caracteres; caso contrário, esse parâmetro é zero.

[in, out] BufferLength

Um ponteiro para uma variável que, na entrada, contém o tamanho, em bytes, do buffer para o qual o Buffer aponta. Se a operação for bem-sucedida, a variável receberá o número de bytes que a estrutura copiou para o buffer.

[out] Buffer

Um ponteiro para um buffer fornecido pelo chamador que recebe o descritor USB. O tipo de buffer deve corresponder ao valor especificado em DescriptorType.

Retornar valor

RetrieveDescriptor retorna um dos seguintes valores:

Comentários

Para obter informações sobre tipos de descritor válidos que um driver UMDF pode passar para o parâmetro DescriptorType , consulte a função WinUsb_GetDescriptor .

O método RetrieveDescriptor gera uma solicitação UMDF e envia a solicitação de forma síncrona para o destino de E/S.

Exemplos

O exemplo de código a seguir recupera um descritor de configuração USB.

HRESULT
CUmdfHidDevice::RetrieveConfigDescriptor(
    __out_bcount(ConfigDescriptorCb) PUSB_CONFIGURATION_DESCRIPTOR *ConfigDescriptor,
    __out ULONG *ConfigDescriptorCb
    )
{
    ULONG descriptorCb = sizeof(USB_CONFIGURATION_DESCRIPTOR);
    USB_CONFIGURATION_DESCRIPTOR descriptorHeader;
    PBYTE descriptorBuffer;
    HRESULT hr;

    //
    // Get the configuration descriptor at index 0
    //

    hr = m_UsbTargetDevice->RetrieveDescriptor(
                            USB_CONFIGURATION_DESCRIPTOR_TYPE,
                            0,
                            0,
                            &descriptorCb,
                            &descriptorHeader
                            );
    //
    // Store the buffer in the output parameter, or delete it.
    //
    if (SUCCEEDED(hr)) {
        *ConfigDescriptor = (PUSB_CONFIGURATION_DESCRIPTOR) (descriptorHeader);
        *ConfigDescriptorCb = descriptorCb;
    }
    else {
        delete[] descriptorHeader;
    }
    return hr;
}

Requisitos

Confira também

IWDFUsbTargetDevice

WinUsb_GetDescriptor