Função GetEnhMetaFileDescriptionW (wingdi.h)

A função GetEnhMetaFileDescription recupera uma descrição de texto opcional de um metarquivo de formato aprimorado e copia a cadeia de caracteres para o buffer especificado.

Sintaxe

UINT GetEnhMetaFileDescriptionW(
  [in]  HENHMETAFILE hemf,
  [in]  UINT         cchBuffer,
  [out] LPWSTR       lpDescription
);

Parâmetros

[in] hemf

Um identificador para o metarquivo aprimorado.

[in] cchBuffer

O tamanho, em caracteres, do buffer para receber os dados. Somente esses muitos caracteres serão copiados.

[out] lpDescription

Um ponteiro para um buffer que recebe a descrição de texto opcional.

Valor retornado

Se a descrição de texto opcional existir e o ponteiro do buffer for NULL, o valor retornado será o comprimento da cadeia de caracteres de texto, em caracteres.

Se a descrição de texto opcional existir e o ponteiro do buffer for um ponteiro válido, o valor retornado será o número de caracteres copiados para o buffer.

Se a descrição do texto opcional não existir, o valor retornado será zero.

Se a função falhar, o valor retornado será GDI_ERROR.

Comentários

A descrição de texto opcional contém duas cadeias de caracteres, a primeira identificando o aplicativo que criou o meta-arquivo aprimorado e a segunda identificando a imagem contida no metarquivo. As cadeias de caracteres são separadas por um caractere nulo e terminadas com dois caracteres nulos, por exemplo, "Editor de Gráficos XYZ\0Bald Eagle\0\0" em que \0 representa o caractere nulo.

Quando os argumentos de texto devem usar caracteres Unicode, use essa função como uma função de caractere largo. Quando os argumentos de texto devem usar caracteres do conjunto de caracteres do Windows, use essa função como uma função ANSI.

Observação

O cabeçalho wingdi.h define GetEnhMetaFileDescription como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos

Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	wingdi.h (inclua Windows.h)
Biblioteca	Gdi32.lib
DLL	Gdi32.dll

Confira também

CreateEnhMetaFile

Funções de metarquivo

Visão geral de meta-arquivos