Image::SetPropertyItem-Methode (gdiplusheaders.h)

Artikel
02/26/2024

Die Image::SetPropertyItem-Methode legt ein Eigenschaftselement (Metadatenelement) für dieses Image-Objekt fest. Wenn das Element bereits vorhanden ist, wird sein Inhalt aktualisiert. Andernfalls wird ein neues Element hinzugefügt.

Syntax

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

Parameter

[in] item

Typ: const PropertyItem*

Zeiger auf ein PropertyItem-Objekt , das das festzulegende Eigenschaftselement angibt.

Rückgabewert

Typ: Status

Wenn die Methode erfolgreich ist, gibt sie OK zurück, ein Element der Status-Enumeration .

Wenn die Methode fehlschlägt, wird eines der anderen Elemente der Status-Enumeration zurückgegeben.

Hinweise

Bestimmte Bildformate (z. B. ICON und EMF) unterstützen eigenschaften nicht. Wenn Sie die Image::SetPropertyItem-Methode für ein Bild aufrufen, das keine Eigenschaften unterstützt, wird PropertyNotSupported zurückgegeben.

Beispiele

Die folgende Konsolenanwendung erstellt ein Image-Objekt basierend auf einer JPEG-Datei. Der Code ruft die Image::SetPropertyItem-Methode dieses Image-Objekts auf, um den Titel des Bilds festzulegen. Anschließend ruft der Code den neuen Titel ab und zeigt den neuen Titel an.

#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;
}

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows XP, Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	gdiplusheaders.h (include Gdiplus.h)
Bibliothek	Gdiplus.lib
DLL	Gdiplus.dll