Xmp Lianja Reference Documentation

Xmp

Current Version: 9.5.0.98

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

Object Creation

loObject = createobject("CkXmp")

Properties

DebugLogFilePath
DebugLogFilePath As Character

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.

More Information and Examples
top
LastErrorHtml
LastErrorHtml As Character (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
LastErrorText As Character (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
LastErrorXml As Character (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
LastMethodSuccess As Boolean

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

top
NumEmbedded
NumEmbedded As Numeric (read-only)

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

top
StructInnerDescrip
StructInnerDescrip As Boolean

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

top
UncommonOptions
UncommonOptions As Character
Introduced in version 9.5.0.80

A property to be used for future uncommon needs. The default value is the empty string.

top
VerboseLogging
VerboseLogging As Boolean

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

top
Version
Version As Character (read-only)

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

More Information and Examples
top

Methods

AddArray
AddArray(xml As CkXml, arrType As Character, propName As Character, values As CkStringArray) As Boolean

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
AddNsMapping(ns As Character, uri As Character)

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
AddSimpleInt(iXml As CkXml, propName As Character, propVal As Numeric) As Boolean

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
AddSimpleStr(iXml As CkXml, propName As Character, propVal As Character) As Boolean

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
AddStructProp(iChilkatXml As CkXml, structName As Character, propName As Character, propValue As Character) As Boolean

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
Append(iXml As CkXml) As Boolean

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
GetArray(iXml As CkXml, propName As Character) As CkStringArray

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

Returns .F. on failure

top
GetEmbedded
GetEmbedded(index As Numeric) As CkXml

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

Returns .F. on failure

More Information and Examples
top
GetProperty
GetProperty(iXml As CkXml, propName As Character) As CkXml

To be documented soon...

Returns .F. on failure

top
GetSimpleInt
GetSimpleInt(iXml As CkXml, propName As Character) As Numeric

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

top
GetSimpleStr
GetSimpleStr(iXml As CkXml, propName As Character) As Character

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

Returns .F. on failure

More Information and Examples
top
GetStructPropNames
GetStructPropNames(iXml As CkXml, structName As Character) As CkStringArray

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 .F. on failure

top
GetStructValue
GetStructValue(iXml As CkXml, structName As Character, propName As Character) As Character

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

Returns .F. on failure

More Information and Examples
top
LoadAppFile
LoadAppFile(filename As Character) As Boolean

Loads a TIFF or JPG file into the XMP object.

top
NewXmp
NewXmp() As CkXml

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

Returns .F. on failure

More Information and Examples
top
RemoveAllEmbedded
RemoveAllEmbedded() As Boolean

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 .T. for success, .F. for failure.

top
RemoveArray
RemoveArray(iXml As CkXml, propName As Character) As Boolean

Removes an XMP array property from the XMP document.

top
RemoveEmbedded
RemoveEmbedded(index As Numeric) As Boolean

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

Returns .T. for success, .F. for failure.

top
RemoveNsMapping
RemoveNsMapping(ns As Character)

Removes a namespace-to-URI mapping.

top
RemoveSimple
RemoveSimple(iXml As CkXml, propName As Character) As Boolean

Removes a simple XMP property from the XMP document.

top
RemoveStruct
RemoveStruct(iXml As CkXml, structName As Character) As Boolean

Removes an XMP structure property from the XMP document.

top
RemoveStructProp
RemoveStructProp(iXml As CkXml, structName As Character, propName As Character) As Boolean

Removes a single member from an XMP structured property.

top
SaveAppFile
SaveAppFile(filename As Character) As Boolean

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