Xmp PureBasic Reference Documentation

Xmp

Current Version: 9.5.0.75

Chilkat XMP is a software component (SDK, toolkit, library, etc) for accessing, manipulating, and adding XMP metadata to JPEG and TIFF files.

Object Creation

obj.i = CkXmp::ckCreate()

; Make sure to dispose of the object when finished like this:
CkXmp::ckDispose(obj);

Properties

DebugLogFilePath
Declare.s ckDebugLogFilePath(obj.i)
Declare setCkDebugLogFilePath(obj.i, value.s)

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:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
LastErrorHtml
Declare.s ckLastErrorHtml(obj.i) ; (read-only)

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.

top
LastErrorText
Declare.s ckLastErrorText(obj.i) ; (read-only)

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.

top
LastErrorXml
Declare.s ckLastErrorXml(obj.i) ; (read-only)

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.

top
LastMethodSuccess
Declare.i ckLastMethodSuccess(obj.i)
Declare setCkLastMethodSuccess(obj.i, value.i)
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
NumEmbedded
Declare.i ckNumEmbedded(obj.i) ; (read-only)

The number of XMP metadata documents found within the JPG or TIFF file loaded by LoadAppFile.

top
StructInnerDescrip
Declare.i ckStructInnerDescrip(obj.i)
Declare setCkStructInnerDescrip(obj.i, value.i)

Determines whether structures are stored with rdf:parseType="Resource", or within an "rdf:Description" sub-node.

top
VerboseLogging
Declare.i ckVerboseLogging(obj.i)
Declare setCkVerboseLogging(obj.i, value.i)

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
Declare.s ckVersion(obj.i) ; (read-only)

Version of the component/library, such as "9.5.0.63"

top

Methods

AddArray
Declare.i ckAddArray(obj.i, xml.i, arrType.s, propName.s, values.i)

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".

More Information and Examples
top
AddNsMapping
Declare ckAddNsMapping(obj.i, ns.s, uri.s)

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.

top
AddSimpleInt
Declare.i ckAddSimpleInt(obj.i, iXml.i, propName.s, propVal.l)

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".

top
AddSimpleStr
Declare.i ckAddSimpleStr(obj.i, iXml.i, propName.s, propVal.s)

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".

top
AddStructProp
Declare.i ckAddStructProp(obj.i, iChilkatXml.i, structName.s, propName.s, propValue.s)

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".

top
Append
Declare.i ckAppend(obj.i, iXml.i)

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.

top
GetArray
Declare.i ckGetArray(obj.i, iXml.i, propName.s)

Finds and returns an XMP array property. The property name should be prefixed with the namespace, such as "dc:subject".

Returns 0 on failure

top
GetEmbedded
Declare.i ckGetEmbedded(obj.i, index.l)

Returns the Nth embedded XMP document as a Chilkat XML object.

Returns 0 on failure

top
GetProperty
Declare.i ckGetProperty(obj.i, iXml.i, propName.s)

To be documented soon...

Returns 0 on failure

top
GetSimpleInt
Declare.i ckGetSimpleInt(obj.i, iXml.i, propName.s)

Finds and returns an XMP integer property. The property name should be prefixed with the namespace, such as "tiff:ResolutionUnit".

top
GetSimpleStr
Declare.s ckGetSimpleStr(obj.i, iXml.i, propName.s)

Finds and returns an XMP simple string property. The property name should be prefixed with the namespace, such as "photoshop:Source".

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

More Information and Examples
top
GetStructPropNames
Declare.i ckGetStructPropNames(obj.i, iXml.i, structName.s)

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 0 on failure

top
GetStructValue
Declare.s ckGetStructValue(obj.i, iXml.i, structName.s, propName.s)

Returns the value of a single item within an XMP structure property. Property names should always be prefixed with the namespace.

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

More Information and Examples
top
LoadAppFile
Declare.i ckLoadAppFile(obj.i, filename.s)

Loads a TIFF or JPG file into the XMP object.

top
NewXmp
Declare.i ckNewXmp(obj.i)

Creates and returns a new/empty XMP metadata document as a Chilkat XML object.

Returns 0 on failure

More Information and Examples
top
RemoveAllEmbedded
Declare.i ckRemoveAllEmbedded(obj.i)

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 1 for success, 0 for failure.

top
RemoveArray
Declare.i ckRemoveArray(obj.i, iXml.i, propName.s)

Removes an XMP array property from the XMP document.

top
RemoveEmbedded
Declare.i ckRemoveEmbedded(obj.i, index.l)

Removes a single XMP metadata document from the JPG or TIFF file. Call SaveAppFile to persist the changes to disk.

Returns 1 for success, 0 for failure.

top
RemoveNsMapping
Declare ckRemoveNsMapping(obj.i, ns.s)

Removes a namespace-to-URI mapping.

top
RemoveSimple
Declare.i ckRemoveSimple(obj.i, iXml.i, propName.s)

Removes a simple XMP property from the XMP document.

top
RemoveStruct
Declare.i ckRemoveStruct(obj.i, iXml.i, structName.s)

Removes an XMP structure property from the XMP document.

top
RemoveStructProp
Declare.i ckRemoveStructProp(obj.i, iXml.i, structName.s, propName.s)

Removes a single member from an XMP structured property.

top
SaveAppFile
Declare.i ckSaveAppFile(obj.i, filename.s)

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.

top
SaveLastError
Declare.i ckSaveLastError(obj.i, path.s)

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns 1 for success, 0 for failure.

top
UnlockComponent
Declare.i ckUnlockComponent(obj.i, unlockCode.s)

Unlocks the XMP component at runtime. This must be called once at the beginning of your application. Passing an arbitrary value initiates a fully-functional 30-day trial. A purchased unlock code is required to use the component beyond 30 days.

top