Método IWDFDevice::RetrieveDeviceInstanceId (wudfddi.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 RetrieveDeviceInstanceId recupera o identificador de uma instância de um dispositivo.

Sintaxe

HRESULT RetrieveDeviceInstanceId(
  [out, optional] PWSTR Buffer,
  [in, out]       DWORD *pdwSizeInChars
);

Parâmetros

[out, optional] Buffer

Um ponteiro para um buffer que recebe uma cadeia de caracteres terminada em NULL que representa o identificador de uma instância do dispositivo, se o buffer fornecido não for NULL e RetrieveDeviceInstanceId for bem-sucedido.

[in, out] pdwSizeInChars

Um ponteiro para uma variável que recebe o número de caracteres, incluindo o caractere NULL , na cadeia de caracteres para a qual o Buffer aponta.

Se Buffer for NULL, o valor fornecido pelo driver será zero. Em seguida, a estrutura retorna o tamanho, em caracteres, que são necessários para a cadeia de caracteres do identificador.

Se Buffer não for NULL, a estrutura retornará o tamanho, em caracteres, da cadeia de caracteres do identificador.

Retornar valor

RetrieveDeviceInstanceId retorna S_OK para os seguintes cenários:

• O buffer que o parâmetro Buffer apontou era não NULL e grande o suficiente para manter a cadeia de caracteres do identificador, incluindo o caractere NULL , e a estrutura copiou com êxito a cadeia de caracteres para o buffer fornecido e definiu a variável que é apontada pelo parâmetro pdwSizeInChars para o número de caracteres na cadeia de caracteres.
• O buffer no Buffer era NULL, o driver predefiniva a variável em pdwSizeInChars como 0 e a estrutura definia a variável em pdwSizeInChars como o número de caracteres necessários para a cadeia de caracteres.

RetrieveDeviceInstanceId retorna HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) para indicar que o buffer fornecido não era NULL e não continha espaço suficiente para manter a cadeia de caracteres do identificador. A estrutura define a variável em pdwSizeInChars como o número de caracteres necessários para a cadeia de caracteres.

RetrieveDeviceInstanceId também pode retornar outros valores HRESULT.

Requisitos

Requisito	Valor
Fim do suporte	Indisponível no UMDF 2.0 e posterior.
Plataforma de Destino	Área de Trabalho
Versão mínima do UMDF	1.5
Cabeçalho	wudfddi.h (include Wudfddi.h)
DLL	WUDFx.dll

Confira também

IWDFDevice