Actions

Difference between revisions of "IPTC"

From XnView Wiki
Line 3: Line 3:
The gflBitmapHasIPTC function is used to know if the picture has IPTC metadata.  
The gflBitmapHasIPTC function is used to know if the picture has IPTC metadata.  


  GFL_BOOL gflBitmapHasIPTC(
  GFL_BOOL <b>gflBitmapHasIPTC</b>(
GFL_BITMAP* bitmap
  GFL_BITMAP* bitmap
  );
  );


Line 25: Line 25:
The gflBitmapGetIPTC function returns IPTC metadata in a readable form.  
The gflBitmapGetIPTC function returns IPTC metadata in a readable form.  


  GFL_IPTC_DATA* gflBitmapGetIPTC(
  GFL_IPTC_DATA* <b>gflBitmapGetIPTC</b>(
  GFL_BITMAP* bitmap
  GFL_BITMAP* bitmap
  );
  );


Line 45: Line 45:
The gflNewIPTC function returns IPTC metadata in a readable form.  
The gflNewIPTC function returns IPTC metadata in a readable form.  


  GFL_IPTC_DATA* gflNewIPTC(
  GFL_IPTC_DATA* <b>gflNewIPTC</b>(
  void
  void
  );
  );


Line 60: Line 60:
The gflFreeIPTC function frees memory allocated by gflBitmapGetIPTC function.  
The gflFreeIPTC function frees memory allocated by gflBitmapGetIPTC function.  


  void gflFreeIPTC(
  void <b>gflFreeIPTC</b>(
  GFL_IPTC_DATA* iptc_data
  GFL_IPTC_DATA* iptc_data
  );
  );


Line 77: Line 77:
The gflSetIPTCValue function set an IPTC value.  
The gflSetIPTCValue function set an IPTC value.  


  GFL_ERROR gflSetIPTCValue(
  GFL_ERROR <b>gflSetIPTCValue</b>(
  GFL_IPTC_DATA* iptc_data,   
  GFL_IPTC_DATA* iptc_data,   
  GFL_UINT32 id,   
  GFL_UINT32 id,   
  const char* value
  const char* value
  );
  );


Line 103: Line 103:
The gflRemoveIPTCValue function remove an IPTC value.  
The gflRemoveIPTCValue function remove an IPTC value.  


  GFL_IPTC_DATA* gflRemoveIPTCValue(
  GFL_IPTC_DATA* <b>gflRemoveIPTCValue</b>(
  GFL_IPTC_DATA* iptc_data,   
  GFL_IPTC_DATA* iptc_data,   
  GFL_UINT32 id
  GFL_UINT32 id
  );
  );


Line 126: Line 126:
The gflLoadIPTC allows to load IPTC data from a picture file, without loading it.  
The gflLoadIPTC allows to load IPTC data from a picture file, without loading it.  


  GFL_IPTC_DATA* gflLoadIPTC(
  GFL_IPTC_DATA* <b>gflLoadIPTC</b>(
  const char*  filename,   
  const char*  filename,   
  );
  );


Line 146: Line 146:
The gflSaveIPTC allows to save IPTC data into a picture file, without loading it.  
The gflSaveIPTC allows to save IPTC data into a picture file, without loading it.  


  GFL_ERROR gflSaveIPTC(
  GFL_ERROR <b>gflSaveIPTC</b>(
  const char*  filename,   
  const char*  filename,   
  const GFL_IPTC_DATA* iptc_data,   
  const GFL_IPTC_DATA* iptc_data,   
  );
  );


Line 169: Line 169:
The gflBitmapSetIPTC function sets IPTC metadata to a bitmap.  
The gflBitmapSetIPTC function sets IPTC metadata to a bitmap.  


  GFL_ERROR gflBitmapSetIPTC(
  GFL_ERROR <b>gflBitmapSetIPTC</b>(
  GFL_BITMAP* bitmap,   
  GFL_BITMAP* bitmap,   
  const GFL_IPTC_DATA* iptc_data
  const GFL_IPTC_DATA* iptc_data
  );
  );


Revision as of 14:18, 23 September 2009

gflBitmapHasIPTC

The gflBitmapHasIPTC function is used to know if the picture has IPTC metadata. 

GFL_BOOL gflBitmapHasIPTC(
  GFL_BITMAP* bitmap
);

Parameters

bitmap
Pointer to a GFL_BITMAP structure.
comment
Pointer to a null-terminated string that contains the comment.

Return value

The function returns GFL_TRUE if the bitmap has IPTC metadata.

See also

gflBitmapHasEXIF, gflBitmapGetIPTC, gflLoadIPTC, gflBitmapGetIPTC


gflBitmapGetIPTC

The gflBitmapGetIPTC function returns IPTC metadata in a readable form. 

GFL_IPTC_DATA* gflBitmapGetIPTC(
  GFL_BITMAP* bitmap
);

Parameters

bitmap
Pointer to a GFL_BITMAP structure.

Return value

The function returns a pointer to a GFL_IPTC_DATA structure.

See also

gflBitmapHasIPTC, gflBitmapSetIPTC, gflFreeIPTC, gflSetIPTCValue, gflRemoveIPTCValue


gflNewIPTC

The gflNewIPTC function returns IPTC metadata in a readable form. 

GFL_IPTC_DATA* gflNewIPTC(
  void
);

Return value

The function returns a pointer to a GFL_IPTC_DATA structure.

See also

gflBitmapHasIPTC, gflFreeIPTC, gflSetIPTCValue, gflRemoveIPTCValue


gflFreeIPTC

The gflFreeIPTC function frees memory allocated by gflBitmapGetIPTC function. 

void gflFreeIPTC(
  GFL_IPTC_DATA* iptc_data
);

Parameters

iptc_data
Pointer to a GFL_IPTC_DATA structure.

See also

gflBitmapGetIPTC, gflLoadIPTC


gflSetIPTCValue

The gflSetIPTCValue function set an IPTC value. 

GFL_ERROR gflSetIPTCValue(
  GFL_IPTC_DATA* iptc_data,  
  GFL_UINT32 id,  
  const char* value
);

Parameters

iptc_data
Pointer to a GFL_IPTC_DATA structure.
id
IPTC id to change.
value
Pointer to a null-terminated string that contains the new value.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

See also

gflBitmapGetIPTC, gflNewIPTC, gflRemoveIPTCValue


gflRemoveIPTCValue

The gflRemoveIPTCValue function remove an IPTC value. 

GFL_IPTC_DATA* gflRemoveIPTCValue(
  GFL_IPTC_DATA* iptc_data,  
  GFL_UINT32 id
);

Parameters

iptc_data
Pointer to a GFL_IPTC_DATA structure.
id
IPTC id to remove.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

See also

gflBitmapGetIPTC, gflNewIPTC, gflSetIPTCValue


gflLoadIPTC

The gflLoadIPTC allows to load IPTC data from a picture file, without loading it. 

GFL_IPTC_DATA* gflLoadIPTC(
  const char*  filename,  
);

Parameters

filename
Pointer to a null-terminated string that contains the filename to extract IPTC. Must be a JPEG file.

Return value

The function returns a pointer to a GFL_IPTC_DATA structure.

See also

gflSaveIPTC, gflSetIPTCValue, gflRemoveIPTCValue, gflFreeIPTC


gflSaveIPTC

The gflSaveIPTC allows to save IPTC data into a picture file, without loading it. 

GFL_ERROR gflSaveIPTC(
  const char*  filename,  
  const GFL_IPTC_DATA* iptc_data,  
);

Parameters

filename
Pointer to a null-terminated string that contains the filename to save. Must be a JPEG file.
iptc_data
Pointer to a GFL_IPTC_DATA structure.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

See also

gflLoadIPTC, gflSetIPTCValue, gflRemoveIPTCValue, gflFreeIPTC


gflBitmapSetIPTC

The gflBitmapSetIPTC function sets IPTC metadata to a bitmap. 

GFL_ERROR gflBitmapSetIPTC(
  GFL_BITMAP* bitmap,  
  const GFL_IPTC_DATA* iptc_data
);

Parameters

bitmap
Pointer to a GFL_BITMAP structure.
iptc_data
Pointer to a GFL_IPTC_DATA structure.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

See also

gflBitmapGetIPTC, gflSetIPTCValue, gflRemoveIPTCValue, gflFreeIPTC
Retrieved from "https://www.xnview.com/wiki/index.php?title=IPTC&oldid=166"