Método IWDFDriver::RetrieveVersionString (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 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 uma cadeia de caracteres terminada em NULL 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, que é necessário para a cadeia de caracteres de versão.

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

Retornar valor

RetrieveVersionString retorna S_OK para os seguintes cenários:

• O buffer para o qual o parâmetro pVersion aponta era não 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 apontada pelo parâmetro pdwVersionLength para o número de caracteres na cadeia de caracteres.
• O buffer em pVersion era NULL, o driver predefiniva a variável em pdwVersionLength como 0 e a estrutura definia a variável em pdwVersionLength como 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 como 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.
Plataforma de Destino	Área de Trabalho
Versão mínima do UMDF	1.5
Cabeçalho	wudfddi.h (include Wudfddi.h)
DLL	WUDFx.dll