Função GetEnhMetaFileDescriptionA (wingdi.h)

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

Sintaxe

UINT GetEnhMetaFileDescriptionA(
  [in]  HENHMETAFILE hemf,
  [in]  UINT         cchBuffer,
  [out] LPSTR        lpDescription
);

Parâmetros

[in] hemf

Um identificador para o metafile 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 de retorno

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 de texto opcional não existir, o valor retornado será zero.

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

Observações

A descrição de texto opcional contém duas cadeias de caracteres, a primeira identificando o aplicativo que criou o metafilo aprimorado e a segunda identificando a imagem contida no metafilo. 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.

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

Requisitos

Consulte também

CreateEnhMetaFile

Funções de metafile

Visão geral de metafiles