Partager via


Image ::SetPropertyItem, méthode (gdiplusheaders.h)

La méthode Image ::SetPropertyItem définit un élément de propriété (morceau de métadonnées) pour cet objet Image . Si l’élément existe déjà, son contenu est mis à jour ; sinon, un nouvel élément est ajouté.

Syntaxe

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

Paramètres

[in] item

Type : const PropertyItem*

Pointeur vers un objet PropertyItem qui spécifie l’élément de propriété à définir.

Valeur retournée

Type : État

Si la méthode réussit, elle retourne Ok, qui est un élément de l’énumération Status .

Si la méthode échoue, elle retourne l’un des autres éléments de l’énumération Status .

Remarques

Certains formats d’image (par exemple, ICON et EMF) ne prennent pas en charge les propriétés. Si vous appelez la méthode Image ::SetPropertyItem sur une image qui ne prend pas en charge les propriétés, elle retourne PropertyNotSupported.

Exemples

L’application console suivante crée un objet Image basé sur un fichier JPEG. Le code appelle la méthode Image ::SetPropertyItem de cet objet Image pour définir le titre de l’image. Ensuite, le code récupère et affiche le nouveau titre.

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

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows XP, Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge Windows 2000 Server [applications de bureau uniquement]
Plateforme cible Windows
En-tête gdiplusheaders.h (inclure Gdiplus.h)
Bibliothèque Gdiplus.lib
DLL Gdiplus.dll

Voir aussi

Image

Image ::GetPropertyCount

Image ::GetPropertyIdList

Image ::GetPropertyItem

Image ::GetPropertyItemSize

Image ::GetPropertySize

Image ::RemovePropertyItem

PropertyItem

Lecture et écriture de métadonnées