Difference between revisions of "IPTC"
From XnView Wiki
| (11 intermediate revisions by 3 users not shown) | |||
| Line 4: | Line 4: | ||
GFL_BOOL <b>gflBitmapHasIPTC</b>( | GFL_BOOL <b>gflBitmapHasIPTC</b>( | ||
GFL_BITMAP* bitmap | const GFL_BITMAP* bitmap | ||
); | ); | ||
| Line 18: | Line 18: | ||
'''See also''' | '''See also''' | ||
:[[EXIF#gflBitmapHasEXIF|gflBitmapHasEXIF]], [[#gflBitmapGetIPTC|gflBitmapGetIPTC]], [[#gflLoadIPTC|gflLoadIPTC]], [[#gflBitmapGetIPTC|gflBitmapGetIPTC]] | :[[EXIF#gflBitmapHasEXIF|gflBitmapHasEXIF]], [[ICC#gflBitmapHasICCProfile|gflBitmapHasICCProfile]], [[#gflBitmapGetIPTC|gflBitmapGetIPTC]], [[#gflLoadIPTC|gflLoadIPTC]], [[#gflBitmapGetIPTC|gflBitmapGetIPTC]] | ||
== gflBitmapGetIPTC == | == gflBitmapGetIPTC == | ||
| Line 26: | Line 25: | ||
GFL_IPTC_DATA* <b>gflBitmapGetIPTC</b>( | GFL_IPTC_DATA* <b>gflBitmapGetIPTC</b>( | ||
GFL_BITMAP* bitmap | const GFL_BITMAP* bitmap | ||
); | ); | ||
| Line 39: | Line 38: | ||
'''See also''' | '''See also''' | ||
:[[#gflBitmapHasIPTC|gflBitmapHasIPTC]], [[#gflBitmapSetIPTC|gflBitmapSetIPTC]], [[#gflFreeIPTC|gflFreeIPTC]], [[#gflSetIPTCValue|gflSetIPTCValue]], [[#gflRemoveIPTCValue|gflRemoveIPTCValue]] | :[[#gflBitmapHasIPTC|gflBitmapHasIPTC]], [[#gflBitmapSetIPTC|gflBitmapSetIPTC]], [[#gflFreeIPTC|gflFreeIPTC]], [[#gflSetIPTCValue|gflSetIPTCValue]], [[#gflRemoveIPTCValue|gflRemoveIPTCValue]] | ||
== gflBitmapSetIPTC == | |||
The gflBitmapSetIPTC function sets IPTC metadata to a bitmap. | |||
GFL_ERROR <b>gflBitmapSetIPTC</b>( | |||
GFL_BITMAP* bitmap, | |||
const GFL_IPTC_DATA* iptc_data | |||
); | |||
'''Parameters''' | |||
: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''' | |||
:[[#gflBitmapGetIPTC|gflBitmapGetIPTC]], [[#gflSetIPTCValue|gflSetIPTCValue]], [[#gflRemoveIPTCValue|gflRemoveIPTCValue]], [[#gflFreeIPTC|gflFreeIPTC]] | |||
| Line 58: | Line 80: | ||
== gflFreeIPTC == | == gflFreeIPTC == | ||
The gflFreeIPTC function frees memory allocated | The gflFreeIPTC function frees memory allocated. | ||
void <b>gflFreeIPTC</b>( | void <b>gflFreeIPTC</b>( | ||
| Line 70: | Line 92: | ||
'''See also''' | '''See also''' | ||
:[[#gflBitmapGetIPTC|gflBitmapGetIPTC]], [[#gflLoadIPTC|gflLoadIPTC]] | :[[#gflBitmapGetIPTC|gflBitmapGetIPTC]], [[#gflLoadIPTC|gflLoadIPTC]] | ||
== gflSetIPTCValue == | == gflSetIPTCValue == | ||
The gflSetIPTCValue function | The gflSetIPTCValue function sets an IPTC value. | ||
GFL_ERROR <b>gflSetIPTCValue</b>( | GFL_ERROR <b>gflSetIPTCValue</b>( | ||
| Line 97: | Line 118: | ||
'''See also''' | '''See also''' | ||
:[[#gflBitmapGetIPTC|gflBitmapGetIPTC]], [[#gflNewIPTC|gflNewIPTC]], [[#gflRemoveIPTCValue|gflRemoveIPTCValue]] | :[[#gflBitmapGetIPTC|gflBitmapGetIPTC]], [[#gflNewIPTC|gflNewIPTC]], [[#gflRemoveIPTCValue|gflRemoveIPTCValue]] | ||
== gflRemoveIPTCValue == | == gflRemoveIPTCValue == | ||
The gflRemoveIPTCValue function | The gflRemoveIPTCValue function removes an IPTC value. | ||
GFL_IPTC_DATA* <b>gflRemoveIPTCValue</b>( | GFL_IPTC_DATA* <b>gflRemoveIPTCValue</b>( | ||
| Line 121: | Line 141: | ||
:[[#gflBitmapGetIPTC|gflBitmapGetIPTC]], [[#gflNewIPTC|gflNewIPTC]], [[#gflSetIPTCValue|gflSetIPTCValue]] | :[[#gflBitmapGetIPTC|gflBitmapGetIPTC]], [[#gflNewIPTC|gflNewIPTC]], [[#gflSetIPTCValue|gflSetIPTCValue]] | ||
== gflClearIPTCKeywords == | |||
The gflClearIPTCKeywords function removes all keywords. | |||
void <b>gflClearIPTCKeywords</b>( | |||
GFL_IPTC_DATA* iptc_data | |||
); | |||
'''Parameters''' | |||
:iptc_data | |||
::Pointer to a [[Structures#GFL_IPTC_DATA|GFL_IPTC_DATA]] structure. | |||
== gflLoadIPTC == | == gflLoadIPTC == | ||
| Line 164: | Line 196: | ||
:[[#gflLoadIPTC|gflLoadIPTC]], [[#gflSetIPTCValue|gflSetIPTCValue]], [[#gflRemoveIPTCValue|gflRemoveIPTCValue]], [[#gflFreeIPTC|gflFreeIPTC]] | :[[#gflLoadIPTC|gflLoadIPTC]], [[#gflSetIPTCValue|gflSetIPTCValue]], [[#gflRemoveIPTCValue|gflRemoveIPTCValue]], [[#gflFreeIPTC|gflFreeIPTC]] | ||
[[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
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
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
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
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
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
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
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
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