Actions

IPTC

From XnView Wiki

gflBitmapHasIPTC

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

GFL_BOOL gflBitmapHasIPTC(
  const 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, gflBitmapHasICCProfile, gflBitmapGetIPTC, gflLoadIPTC, gflBitmapGetIPTC

gflBitmapGetIPTC

The gflBitmapGetIPTC function returns IPTC metadata in a readable form.

GFL_IPTC_DATA* gflBitmapGetIPTC(
  const 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


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


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.

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 sets 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 removes 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

gflClearIPTCKeywords

The gflClearIPTCKeywords function removes all keywords.

void gflClearIPTCKeywords( 
  GFL_IPTC_DATA* iptc_data 
); 

Parameters

iptc_data
Pointer to a GFL_IPTC_DATA structure.

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