Método IWDFDevice::RetrieveDeviceInstanceId (wudfddi.h)

Artigo
02/07/2025

[Aviso: UMDF 2 é a versão mais recente do UMDF e substitui o UMDF 1. Todos os novos drivers UMDF devem ser gravados usando UMDF 2. Nenhum recurso novo está sendo adicionado ao UMDF 1 e há suporte limitado para UMDF 1 em versões mais recentes do Windows 10. Os drivers universais do Windows devem usar o UMDF 2. Para obter mais informações, consulte Introdução aoda 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 um cadeia de caracteres nullterminada 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 à qual Buffer aponta.

Se de 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 de Buffer não forNULL, a estrutura retornará o tamanho, em caracteres, da cadeia de caracteres do identificador.

Valor de retorno

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 no 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 em buffer foi NULL, o driver predefini a variável em pdwSizeInChars como 0 e a estrutura definiu a variável em pdwSizeInChars para 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 para 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.
da Plataforma de Destino	Área de trabalho
versão mínima do UMDF	1.5
cabeçalho	wudfddi.h (inclua Wudfddi.h)
de DLL	WUDFx.dll

Consulte também

IWDFDevice

Compartilhar via