Xmp C Reference Documentation
Xmp
Current Version: 10.1.0
Chilkat XMP is a software component (SDK, toolkit, library, etc) for accessing, manipulating, and adding XMP metadata to JPEG and TIFF files.
Create/Dispose
HCkXmp instance = CkXmp_Create(); // ... CkXmp_Dispose(instance);
Creates an instance of the HCkXmp object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.
Objects created by calling CkXmp_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkXmp_Dispose.
Properties
DebugLogFilePath
void CkXmp_putDebugLogFilePath(HCkXmp cHandle, const char *newVal);
const char *CkXmp_debugLogFilePath(HCkXmp cHandle);
If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.
This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:
- a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
- the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
- there is an internal problem (bug) in the Chilkat code that causes the hang.
LastErrorHtml
const char *CkXmp_lastErrorHtml(HCkXmp cHandle);
Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
topLastErrorText
const char *CkXmp_lastErrorText(HCkXmp cHandle);
Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
LastErrorXml
const char *CkXmp_lastErrorXml(HCkXmp cHandle);
Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
topLastMethodSuccess
void CkXmp_putLastMethodSuccess(HCkXmp cHandle, BOOL newVal);
Indicate whether the last method call succeeded or failed. A value of TRUE indicates success, a value of FALSE indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:
- Any method that returns a string.
- Any method returning a Chilkat object, binary bytes, or a date/time.
- Any method returning a standard boolean status value where success = TRUE and failure = FALSE.
- Any method returning an integer where failure is defined by a return value less than zero.
Note: Methods that do not fit the above requirements will always set this property equal to TRUE. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.
topNumEmbedded
The number of XMP metadata documents found within the JPG or TIFF file loaded by LoadAppFile.
topStructInnerDescrip
void CkXmp_putStructInnerDescrip(HCkXmp cHandle, BOOL newVal);
Determines whether structures are stored with rdf:parseType="Resource", or within an "rdf:Description" sub-node.
topUncommonOptions
void CkXmp_putUncommonOptions(HCkXmp cHandle, const char *newVal);
const char *CkXmp_uncommonOptions(HCkXmp cHandle);
A property to be used for future uncommon needs. The default value is the empty string.
topUtf8
void CkXmp_putUtf8(HCkXmp cHandle, BOOL newVal);
When set to TRUE, all "const char *" arguments are interpreted as utf-8 strings. If set to FALSE (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to TRUE, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to FALSE, all "const char *" return values are ANSI strings.
topVerboseLogging
void CkXmp_putVerboseLogging(HCkXmp cHandle, BOOL newVal);
If set to TRUE, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is FALSE. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
topVersion
Methods
AddArray
Adds or replaces an XMP property array. The XMP metadata to be updated is contained in the XML object passed in the 1st argument. The 2nd argument specifies the array type, which can be "bag", "seq", or "alt". The property name should be prefixed with the namespace, such as "dc:subject".
AddNsMapping
Adds a namespace to URI mapping. When a property is added via AddSimpleString or any of the other methods, the property name is namespace qualified. When adding the first property in a namespace, the rdf:Description is automatically added and the URI is obtained from the namespace-to-URI mappings. The standard (and commonly used) namespace mappings are defined by default. This is only used if the namespace is custom or not already handled.
topAddSimpleInt
Adds or updates an XMP integer property. The XMP metadata to be updated is contained in the XML object passed in the 1st argument. The property name should be prefixed with the namespace, such as "tiff:XResolution".
topAddSimpleStr
Adds or updates a simple XMP string property. The XMP metadata to be updated is contained in the XML object passed in the 1st argument. The property name should be prefixed with the namespace, such as "photoshop:Credit".
topAddStructProp
Adds or updates an XMP structured property value. The XMP metadata to be updated is contained in the XML object passed in the 1st argument. The structure name should be prefixed with the namespace, such as "Iptc4xmpCore:CreatorContactInfo". The property name within the structure should also be prefixed with the namespace, such as "Iptc4xmpCore:CiAdrCity".
topAppend
Appends a new XMP metadata file to the XMP object. Any XMPs appended via this method will be present in the file when SaveAppFile is called. Files containing XMP metadata typically only include a single XMP document, so this method is usually only called when adding XMP metadata to a file for the first time.
topGetArray
Finds and returns an XMP array property. The property name should be prefixed with the namespace, such as "dc:subject".
Returns NULL on failure
topGetEmbedded
Returns the Nth embedded XMP document as a Chilkat XML object.
Returns NULL on failure
GetProperty
GetSimpleInt
Finds and returns an XMP integer property. The property name should be prefixed with the namespace, such as "tiff:ResolutionUnit".
topGetSimpleStr
const char *CkXmp_getSimpleStr(HCkXmp cHandle, HCkXml iXml, const char *propName);
Finds and returns an XMP simple string property. The property name should be prefixed with the namespace, such as "photoshop:Source".
Returns TRUE for success, FALSE for failure.
GetStructPropNames
Returns the property names used by an exsting structure within an XMP document. The contents of the structure can be retrieved by calling GetStructValue for each property name returned by GetStructPropNames.
Returns NULL on failure
topGetStructValue
const char *CkXmp_getStructValue(HCkXmp cHandle, HCkXml iXml, const char *structName, const char *propName);
Returns the value of a single item within an XMP structure property. Property names should always be prefixed with the namespace.
Returns TRUE for success, FALSE for failure.
LoadAppFile
Loads a TIFF or JPG file into the XMP object.
topLoadFromBuffer
Loads a JPG or TIFF from an byte buffer containing the image file data.
topNewXmp
Creates and returns a new/empty XMP metadata document as a Chilkat XML object.
Returns NULL on failure
RemoveAllEmbedded
Removes all XMP metadata documents from an XMP object. After calling this method, call SaveAppFile to rewrite the JPG or TIFF file with the XMP metadata removed.
Returns TRUE for success, FALSE for failure.
topRemoveArray
Removes an XMP array property from the XMP document.
topRemoveEmbedded
Removes a single XMP metadata document from the JPG or TIFF file. Call SaveAppFile to persist the changes to disk.
Returns TRUE for success, FALSE for failure.
topRemoveNsMapping
Removes a namespace-to-URI mapping.
topRemoveSimple
Removes a simple XMP property from the XMP document.
topRemoveStruct
Removes an XMP structure property from the XMP document.
topRemoveStructProp
Removes a single member from an XMP structured property.
topSaveAppFile
Persists all changes made to the XMP document(s) by saving the XMP object to a file. Changes made by adding, updating, or removing properties are not persisted to the filesystem until this is called.
topSaveToBuffer
Saves a JPG or TIFF image with updated XMP to a byte buffer.
Returns TRUE for success, FALSE for failure.
top