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…')
 
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 gflBitmapHasIPTC(
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]], [[#gflBitmapGetIPTC|gflBitmapGetIPTC]], [[#gflLoadIPTC|gflLoadIPTC]], [[#gflBitmapGetIPTC|gflBitmapGetIPTC]]


The function returns GFL_TRUE if the bitmap has IPTC metadata.


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


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_BITMAP* bitmap
);


GFL_IPTC_DATA * gflBitmapGetIPTC(
'''Parameters'''
  GFL_BITMAP * bitmap
);


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


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


Return value
'''See also'''
:[[#gflBitmapHasIPTC|gflBitmapHasIPTC]], [[#gflBitmapSetIPTC|gflBitmapSetIPTC]], [[#gflFreeIPTC|gflFreeIPTC]], [[#gflSetIPTCValue|gflSetIPTCValue]], [[#gflRemoveIPTCValue|gflRemoveIPTCValue]]


The function returns a pointer to a GFL_IPTC_DATA structure.


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


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 * gflNewIPTC(
   void
   void
);
);
 


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'''
:[[#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
 
 
 
gflFreeIPTC


The gflFreeIPTC function frees memory allocated by gflBitmapGetIPTC function.  
The gflFreeIPTC function frees memory allocated by gflBitmapGetIPTC function.  


void gflFreeIPTC(
  GFL_IPTC_DATA* iptc_data
);


void gflFreeIPTC(
'''Parameters'''
  GFL_IPTC_DATA * iptc_data
);


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


iptc_data
'''See also'''
Pointer to a GFL_IPTC_DATA structure.
:[[#gflBitmapGetIPTC|gflBitmapGetIPTC]], [[#gflLoadIPTC|gflLoadIPTC]]


See also


gflBitmapSetComment, gflBitmapRemoveMetaData, gflBitmapHasEXIF, gflBitmapRemoveEXIFThumbnail, gflBitmapGetEXIF, gflFreeEXIF, gflBitmapHasIPTC, gflBitmapGetIPTC
== gflSetIPTCValue ==
 
gflSetIPTCValue


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


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


iptc_data
'''Parameters'''
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  
: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.


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


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


See also


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


The gflRemoveIPTCValue function remove an IPTC value.  
The gflRemoveIPTCValue function remove an IPTC value.  


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


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 remove.  
::IPTC id to remove.  


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]]




See also
== gflLoadIPTC ==
 
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* gflLoadIPTC(
  const char*  filename, 
);


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


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


filename
'''Return value'''
Pointer to a null-terminated string that contains the filename to extract IPTC. Must be a JPEG file.  
:The function returns a pointer to a [[Structures#GFL_IPTC_DATA|GFL_IPTC_DATA]] structure.


Return value
'''See also'''
:[[#gflSaveIPTC|gflSaveIPTC]], [[#gflSetIPTCValue|gflSetIPTCValue]], [[#gflRemoveIPTCValue|gflRemoveIPTCValue]], [[#gflFreeIPTC|gflFreeIPTC]]


The function returns a pointer to a GFL_IPTC_DATA structure.


 
== gflSaveIPTC ==
See also
 
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 gflSaveIPTC(
  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 [[Structures#GFL_IPTC_DATA|GFL_IPTC_DATA]] structure.


filename
'''Return value'''
Pointer to a null-terminated string that contains the filename to save. Must be a JPEG file.
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].  
iptc_data
Pointer to a GFL_IPTC_DATA structure.  


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


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


 
== gflBitmapSetIPTC ==
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.  
The gflBitmapSetIPTC function sets IPTC metadata to a bitmap.  


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


GFL_ERROR gflBitmapSetIPTC(
'''Parameters'''
  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.


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


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


gflBitmapSetComment, gflBitmapRemoveMetaData, gflBitmapHasEXIF, gflBitmapRemoveEXIFThumbnail, gflBitmapGetEXIF, gflFreeEXIF, gflBitmapHasIPTC, gflBitmapGetIPTC, gflFreeIPTC, gflNewIPTC, gflSetIPTCValue, gflRemoveIPTCValue, gflLoadIPTC, gflSaveIPTC
'''See also'''
:[[#gflBitmapGetIPTC|gflBitmapGetIPTC]], [[#gflSetIPTCValue|gflSetIPTCValue]], [[#gflRemoveIPTCValue|gflRemoveIPTCValue]], [[#gflFreeIPTC|gflFreeIPTC]]

Revision as of 12:39, 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=149"