Actions

Difference between revisions of "IPTC"

From XnView Wiki

(Created page with 'gflBitmapHasIPTC The gflBitmapHasIPTC function is used to know if the picture has IPTC metadata. GFL_BOOL gflBitmapHasIPTC( GFL_BITMAP * bitmap ); Parameters bitmap Poi…')
 
m (Reverted edits by Akajavim (Talk) to last revision by WikiSysop)
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
gflBitmapHasIPTC
== gflBitmapHasIPTC ==


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 <b>gflBitmapHasIPTC</b>(
  const GFL_BITMAP* bitmap
);


GFL_BOOL gflBitmapHasIPTC(
'''Parameters'''
  GFL_BITMAP * bitmap
);


Parameters
:bitmap
::Pointer to a [[Structures#GFL_BITMAP|GFL_BITMAP]] structure.
:comment
::Pointer to a null-terminated string that contains the comment.


bitmap
'''Return value'''
Pointer to a GFL_BITMAP structure.
:The function returns GFL_TRUE if the bitmap has IPTC metadata.  
comment
Pointer to a null-terminated string that contains the comment.  


Return value
'''See also'''
:[[EXIF#gflBitmapHasEXIF|gflBitmapHasEXIF]], [[ICC#gflBitmapHasICCProfile|gflBitmapHasICCProfile]], [[#gflBitmapGetIPTC|gflBitmapGetIPTC]], [[#gflLoadIPTC|gflLoadIPTC]], [[#gflBitmapGetIPTC|gflBitmapGetIPTC]]


The function returns GFL_TRUE if the bitmap has IPTC metadata.
== gflBitmapGetIPTC ==


The gflBitmapGetIPTC function returns IPTC metadata in a readable form.


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


gflBitmapSetComment, gflBitmapRemoveMetaData, gflBitmapHasEXIF, gflBitmapRemoveEXIFThumbnail, gflBitmapGetEXIF, gflFreeEXIF, gflBitmapGetIPTC, gflBitmapSetIPTC, gflFreeIPTC, gflNewIPTC, gflSetIPTCValue, gflRemoveIPTCValue, gflLoadIPTC, gflSaveIPTC
'''Parameters'''


:bitmap
::Pointer to a [[Structures#GFL_BITMAP|GFL_BITMAP]] structure.


gflBitmapGetIPTC
'''Return value'''
:The function returns a pointer to a [[Structures#GFL_IPTC_DATA|GFL_IPTC_DATA]] structure.


The gflBitmapGetIPTC function returns IPTC metadata in a readable form.
'''See also'''
:[[#gflBitmapHasIPTC|gflBitmapHasIPTC]], [[#gflBitmapSetIPTC|gflBitmapSetIPTC]], [[#gflFreeIPTC|gflFreeIPTC]], [[#gflSetIPTCValue|gflSetIPTCValue]], [[#gflRemoveIPTCValue|gflRemoveIPTCValue]]




GFL_IPTC_DATA * gflBitmapGetIPTC(
== gflBitmapSetIPTC ==
  GFL_BITMAP * bitmap
);


Parameters
The gflBitmapSetIPTC function sets IPTC metadata to a bitmap.


bitmap  
GFL_ERROR <b>gflBitmapSetIPTC</b>(
Pointer to a GFL_BITMAP structure.
  GFL_BITMAP* bitmap, 
  const GFL_IPTC_DATA* iptc_data
);


Return value
'''Parameters'''


The function returns a pointer to a GFL_IPTC_DATA structure.
:bitmap
::Pointer to a [[Structures#GFL_BITMAP|GFL_BITMAP]] structure.
:iptc_data
::Pointer to a [[Structures#GFL_IPTC_DATA|GFL_IPTC_DATA]] structure.  


'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].


See also  
'''See also'''
:[[#gflBitmapGetIPTC|gflBitmapGetIPTC]], [[#gflSetIPTCValue|gflSetIPTCValue]], [[#gflRemoveIPTCValue|gflRemoveIPTCValue]], [[#gflFreeIPTC|gflFreeIPTC]]


gflBitmapSetComment, gflBitmapRemoveMetaData, gflBitmapHasEXIF, gflBitmapRemoveEXIFThumbnail, gflBitmapGetEXIF, gflFreeEXIF, gflBitmapHasIPTC, gflBitmapSetIPTC, gflFreeIPTC, gflNewIPTC, gflSetIPTCValue, gflRemoveIPTCValue, gflLoadIPTC, gflSaveIPTC


 
== gflNewIPTC ==
gflNewIPTC


The gflNewIPTC function returns IPTC metadata in a readable form.  
The gflNewIPTC function returns IPTC metadata in a readable form.  


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


GFL_IPTC_DATA * gflNewIPTC(
'''Return value'''
  void
:The function returns a pointer to a [[Structures#GFL_IPTC_DATA|GFL_IPTC_DATA]] structure.
);
 
 
Return value  


The function returns a pointer to a GFL_IPTC_DATA structure.
'''See also'''
:[[#gflBitmapHasIPTC|gflBitmapHasIPTC]], [[#gflFreeIPTC|gflFreeIPTC]], [[#gflSetIPTCValue|gflSetIPTCValue]], [[#gflRemoveIPTCValue|gflRemoveIPTCValue]]




See also
== gflFreeIPTC ==


gflBitmapSetComment, gflBitmapRemoveMetaData, gflBitmapHasEXIF, gflBitmapRemoveEXIFThumbnail, gflBitmapGetEXIF, gflFreeEXIF, gflBitmapHasIPTC, gflBitmapGetIPTC, gflBitmapSetIPTC, gflFreeIPTC, gflSetIPTCValue, gflRemoveIPTCValue, gflLoadIPTC, gflSaveIPTC
The gflFreeIPTC function frees memory allocated.


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


'''Parameters'''


gflFreeIPTC
:iptc_data
::Pointer to a [[Structures#GFL_IPTC_DATA|GFL_IPTC_DATA]] structure.


The gflFreeIPTC function frees memory allocated by gflBitmapGetIPTC function.
'''See also'''
:[[#gflBitmapGetIPTC|gflBitmapGetIPTC]], [[#gflLoadIPTC|gflLoadIPTC]]


== gflSetIPTCValue ==


void gflFreeIPTC(
The gflSetIPTCValue function sets an IPTC value.
  GFL_IPTC_DATA * iptc_data
);


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


iptc_data
'''Parameters'''
Pointer to a GFL_IPTC_DATA structure.


See also
:iptc_data
::Pointer to a [[Structures#GFL_IPTC_DATA|GFL_IPTC_DATA]] structure.
:id
::IPTC id to change.
:value
::Pointer to a null-terminated string that contains the new value.


gflBitmapSetComment, gflBitmapRemoveMetaData, gflBitmapHasEXIF, gflBitmapRemoveEXIFThumbnail, gflBitmapGetEXIF, gflFreeEXIF, gflBitmapHasIPTC, gflBitmapGetIPTC
'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].


gflSetIPTCValue
'''See also'''
:[[#gflBitmapGetIPTC|gflBitmapGetIPTC]], [[#gflNewIPTC|gflNewIPTC]], [[#gflRemoveIPTCValue|gflRemoveIPTCValue]]


The gflSetIPTCValue function set an IPTC value.
== gflRemoveIPTCValue ==


The gflRemoveIPTCValue function removes an IPTC value.


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


Parameters  
'''Parameters'''


iptc_data  
:iptc_data  
Pointer to a GFL_IPTC_DATA structure.  
::Pointer to a [[Structures#GFL_IPTC_DATA|GFL_IPTC_DATA]] structure.  
id  
:id  
IPTC id to change.
::IPTC id to remove.  
value
Pointer to a null-terminated string that contains the new value.  


Return value  
'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].


The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.
'''See also'''
:[[#gflBitmapGetIPTC|gflBitmapGetIPTC]], [[#gflNewIPTC|gflNewIPTC]], [[#gflSetIPTCValue|gflSetIPTCValue]]


== gflClearIPTCKeywords ==


See also
The gflClearIPTCKeywords function removes all keywords.


gflBitmapSetComment, gflBitmapRemoveMetaData, gflBitmapHasEXIF, gflBitmapRemoveEXIFThumbnail, gflBitmapGetEXIF, gflFreeEXIF, gflBitmapHasIPTC, gflBitmapGetIPTC, gflBitmapSetIPTC, gflFreeIPTC, gflNewIPTC, gflRemoveIPTCValue, gflLoadIPTC, gflSaveIPTC
void <b>gflClearIPTCKeywords</b>(
  GFL_IPTC_DATA* iptc_data
);


'''Parameters'''


gflRemoveIPTCValue
:iptc_data
::Pointer to a [[Structures#GFL_IPTC_DATA|GFL_IPTC_DATA]] structure.


The gflRemoveIPTCValue function remove an IPTC value.
== gflLoadIPTC ==
 
 
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
 
gflBitmapSetComment, gflBitmapRemoveMetaData, gflBitmapHasEXIF, gflBitmapRemoveEXIFThumbnail, gflBitmapGetEXIF, gflFreeEXIF, gflBitmapHasIPTC, gflBitmapGetIPTC, gflBitmapSetIPTC, gflFreeIPTC, gflNewIPTC, gflSetIPTCValue, gflLoadIPTC, gflSaveIPTC
 
 
gflLoadIPTC


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* <b>gflLoadIPTC</b>(
  const char*  filename, 
);


GFL_IPTC_DATA * gflLoadIPTC(
'''Parameters'''
  const char *  filename, 
);
 
Parameters  


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


Return value  
'''Return value'''
:The function returns a pointer to a [[Structures#GFL_IPTC_DATA|GFL_IPTC_DATA]] structure.


The function returns a pointer to a GFL_IPTC_DATA structure.
'''See also'''
:[[#gflSaveIPTC|gflSaveIPTC]], [[#gflSetIPTCValue|gflSetIPTCValue]], [[#gflRemoveIPTCValue|gflRemoveIPTCValue]], [[#gflFreeIPTC|gflFreeIPTC]]




See also
== gflSaveIPTC ==
 
gflBitmapSetComment, gflBitmapRemoveMetaData, gflBitmapHasEXIF, gflBitmapRemoveEXIFThumbnail, gflBitmapGetEXIF, gflFreeEXIF, gflBitmapHasIPTC, gflBitmapGetIPTC, gflBitmapSetIPTC, gflFreeIPTC, gflNewIPTC, gflSetIPTCValue, gflRemoveIPTCValue, gflSaveIPTC
 
 
gflSaveIPTC


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 <b>gflSaveIPTC</b>(
  const char*  filename, 
  const GFL_IPTC_DATA* iptc_data, 
);


GFL_ERROR gflSaveIPTC(
'''Parameters'''
  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
 
gflBitmapSetComment, gflBitmapRemoveMetaData, gflBitmapHasEXIF, gflBitmapRemoveEXIFThumbnail, gflBitmapGetEXIF, gflFreeEXIF, gflBitmapHasIPTC, gflBitmapGetIPTC, gflBitmapSetIPTC, gflFreeIPTC, gflNewIPTC, gflSetIPTCValue, gflRemoveIPTCValue, gflLoadIPTC
 
 
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.  
:filename
::Pointer to a null-terminated string that contains the filename to save. Must be a JPEG file.
:iptc_data
::Pointer to a [[Structures#GFL_IPTC_DATA|GFL_IPTC_DATA]] structure.  


'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].


See also  
'''See also'''
:[[#gflLoadIPTC|gflLoadIPTC]], [[#gflSetIPTCValue|gflSetIPTCValue]], [[#gflRemoveIPTCValue|gflRemoveIPTCValue]], [[#gflFreeIPTC|gflFreeIPTC]]


gflBitmapSetComment, gflBitmapRemoveMetaData, gflBitmapHasEXIF, gflBitmapRemoveEXIFThumbnail, gflBitmapGetEXIF, gflFreeEXIF, gflBitmapHasIPTC, gflBitmapGetIPTC, gflFreeIPTC, gflNewIPTC, gflSetIPTCValue, gflRemoveIPTCValue, gflLoadIPTC, gflSaveIPTC
[[Category: GFLSDK Reference Manual]]

Latest revision as of 15:26, 22 November 2010

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
Retrieved from "https://www.xnview.com/wiki/index.php?title=IPTC&oldid=572"