Método Image::SetPropertyItem (gdiplusheaders.h)

Artigo
02/29/2024

O método Image::SetPropertyItem define um item de propriedade (parte dos metadados) para este objeto Image . Se o item já existir, seu conteúdo será atualizado; caso contrário, um novo item será adicionado.

Sintaxe

Status SetPropertyItem(
  [in] const PropertyItem *item
);

Parâmetros

[in] item

Tipo: const PropertyItem*

Ponteiro para um objeto PropertyItem que especifica o item de propriedade a ser definido.

Retornar valor

Tipo: Status

Se o método for bem-sucedido, ele retornará Ok, que é um elemento da enumeração Status .

Se o método falhar, ele retornará um dos outros elementos da enumeração Status .

Comentários

Determinados formatos de imagem (por exemplo, ICON e EMF) não dão suporte a propriedades. Se você chamar o método Image::SetPropertyItem em uma imagem que não dá suporte a propriedades, ele retornará PropertyNotSupported.

Exemplos

O aplicativo de console a seguir cria um objeto Image com base em um arquivo JPEG. O código chama o método Image::SetPropertyItem desse objeto Image para definir o título da imagem. Em seguida, o código recupera e exibe o novo título.

#include <windows.h>
#include <gdiplus.h>
#include <stdio.h>
using namespace Gdiplus;

INT main()
{
   GdiplusStartupInput gdiplusStartupInput;
   ULONG_PTR gdiplusToken;
   GdiplusStartup(&gdiplusToken, &gdiplusStartupInput, NULL);

   // Create an Image object based on a JPEG file.
   Image* image = new Image(L"FakePhoto.jpg");

   // Set the image title.
   PropertyItem* propItem = new PropertyItem;
   CHAR newTitleValue[] = "Fake Photograph 2";

   propItem->id = PropertyTagImageTitle;
   propItem->length = 18;  //  includes null terminator
   propItem->type = PropertyTagTypeASCII;
   propItem->value = newTitleValue;

   image->SetPropertyItem(propItem);

   // Get and display the new image title.
   UINT size = image->GetPropertyItemSize(PropertyTagImageTitle);
   PropertyItem* title = (PropertyItem*)malloc(size);
   image->GetPropertyItem(PropertyTagImageTitle, size, title);
   printf("The image title is %s.\n", title->value);

   free(title);
   delete propItem;
   delete image;
   GdiplusShutdown(gdiplusToken);
   return 0;
}

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows XP, 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	gdiplusheaders.h (inclua Gdiplus.h)
Biblioteca	Gdiplus.lib
DLL	Gdiplus.dll