Compartilhar via


Método IWDFDriver::RetrieveVersionString (wudfddi.h)

[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 RetrieveVersionString recupera a versão da estrutura.

Sintaxe

HRESULT RetrieveVersionString(
  [out]     PWSTR pVersion,
  [in, out] DWORD *pdwVersionLength
);

Parâmetros

[out] pVersion

Um ponteiro para um buffer que recebe um cadeia de caracteres nullterminada que representa a versão da estrutura se o buffer fornecido não for NULL e retrieveVersionString for bem-sucedido.

[in, out] pdwVersionLength

Um ponteiro para uma variável que recebe o tamanho, em caracteres, da cadeia de caracteres de versão para a qual pVersion aponta. Na entrada, essa variável contém o tamanho, em bytes, do buffer em pVersion.

Se o buffer em pVersion for NULL, o valor fornecido pelo driver será zero. Em seguida, a estrutura retorna o tamanho, em caracteres, necessário para a cadeia de caracteres de versão.

Se o buffer em pVersion não forNULL, a estrutura retornará o tamanho, em caracteres, da cadeia de caracteres de versão.

Valor de retorno

RetrieveVersionString retorna S_OK para os seguintes cenários:

  • O buffer ao qual o parâmetro pVersion aponta era NULL e grande o suficiente para manter a cadeia de caracteres de versão, incluindo o caractere NULL. Além disso, a estrutura copiou com êxito a cadeia de caracteres para o buffer fornecido e definiu a variável que é apontada pelo parâmetro pdwVersionLength para o número de caracteres na cadeia de caracteres.
  • O buffer em pVersion foi NULL, o driver predefini a variável em pdwVersionLength como 0 e a estrutura definiu a variável em pdwVersionLength para o número de caracteres necessários para a cadeia de caracteres.
RetrieveVersionString retorna HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) para indicar que o buffer fornecido não é NULL e não continha espaço suficiente para manter a versão. A estrutura define a variável em pdwVersionLength para o número de caracteres necessários para a cadeia de caracteres.

RetrieveVersionString 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