Xmp Delphi DLL Reference Documentation

Xmp

Current Version: 10.1.3

Requires Chilkat Bundle License

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

Create/Dispose

var
myObject: HCkXmp;

begin
myObject := CkXmp_Create();

// ...

CkXmp_Dispose(myObject);
end;

function CkXmp_Create: HCkXmp; stdcall;

Creates an instance of the HCkXmp object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkXmp_Dispose(handle: HCkXmp); stdcall;

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.

Properties

DebugLogFilePath

procedure CkXmp_getDebugLogFilePath(objHandle: HCkXmp; outPropVal: HCkString); stdcall;
procedure CkXmp_putDebugLogFilePath(objHandle: HCkXmp; newPropVal: PWideChar); stdcall;
function CkXmp__debugLogFilePath(objHandle: HCkXmp): PWideChar; stdcall;

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Example showing how to use DebugLogFilePath.

LastErrorHtml

procedure CkXmp_getLastErrorHtml(objHandle: HCkXmp; outPropVal: HCkString); stdcall;
function CkXmp__lastErrorHtml(objHandle: HCkXmp): PWideChar; stdcall;

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

See the notes about PWideChar memory ownership and validity.

LastErrorText

procedure CkXmp_getLastErrorText(objHandle: HCkXmp; outPropVal: HCkString); stdcall;
function CkXmp__lastErrorText(objHandle: HCkXmp): PWideChar; stdcall;

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

procedure CkXmp_getLastErrorXml(objHandle: HCkXmp; outPropVal: HCkString); stdcall;
function CkXmp__lastErrorXml(objHandle: HCkXmp): PWideChar; stdcall;

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

See the notes about PWideChar memory ownership and validity.

LastMethodSuccess

function CkXmp_getLastMethodSuccess(objHandle: HCkXmp): wordbool; stdcall;
procedure CkXmp_putLastMethodSuccess(objHandle: HCkXmp; newPropVal: wordbool); stdcall;

Indicates the success or failure of the most recent method call: True means success, False means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

NumEmbedded

function CkXmp_getNumEmbedded(objHandle: HCkXmp): Integer; stdcall;

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

StructInnerDescrip

function CkXmp_getStructInnerDescrip(objHandle: HCkXmp): wordbool; stdcall;
procedure CkXmp_putStructInnerDescrip(objHandle: HCkXmp; newPropVal: wordbool); stdcall;

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

UncommonOptions

procedure CkXmp_getUncommonOptions(objHandle: HCkXmp; outPropVal: HCkString); stdcall;
procedure CkXmp_putUncommonOptions(objHandle: HCkXmp; newPropVal: PWideChar); stdcall;
function CkXmp__uncommonOptions(objHandle: HCkXmp): PWideChar; stdcall;

Introduced in version 9.5.0.80

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

See the notes about PWideChar memory ownership and validity.

VerboseLogging

function CkXmp_getVerboseLogging(objHandle: HCkXmp): wordbool; stdcall;
procedure CkXmp_putVerboseLogging(objHandle: HCkXmp; newPropVal: wordbool); stdcall;

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.

Version

procedure CkXmp_getVersion(objHandle: HCkXmp; outPropVal: HCkString); stdcall;
function CkXmp__version(objHandle: HCkXmp): PWideChar; stdcall;

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

See the notes about PWideChar memory ownership and validity.

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddArray

function CkXmp_AddArray(objHandle: HCkXmp;
    xml: HCkXml;
    arrType: PWideChar;
    propName: PWideChar;
    values: HCkStringArray): wordbool; stdcall;

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

XMP Array Property - Bag, Seq, or Alt

AddNsMapping

procedure CkXmp_AddNsMapping(objHandle: HCkXmp;
ns: PWideChar;
uri: PWideChar) stdcall;

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.

AddSimpleInt

function CkXmp_AddSimpleInt(objHandle: HCkXmp;
    iXml: HCkXml;
    propName: PWideChar;
    propVal: Integer): wordbool; stdcall;

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

AddSimpleStr

function CkXmp_AddSimpleStr(objHandle: HCkXmp;
    iXml: HCkXml;
    propName: PWideChar;
    propVal: PWideChar): wordbool; stdcall;

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

AddStructProp

function CkXmp_AddStructProp(objHandle: HCkXmp;
    iChilkatXml: HCkXml;
    structName: PWideChar;
    propName: PWideChar;
    propValue: PWideChar): wordbool; stdcall;

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

Append

function CkXmp_Append(objHandle: HCkXmp;
iXml: HCkXml): wordbool; stdcall;

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.

GetArray

function CkXmp_GetArray(objHandle: HCkXmp;
iXml: HCkXml;
propName: PWideChar): HCkStringArray; stdcall;

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

Returns nil on failure

GetEmbedded

function CkXmp_GetEmbedded(objHandle: HCkXmp;
index: Integer): HCkXml; stdcall;

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

Returns nil on failure

More Information and Examples

Extract XMP MetaData as XML

GetProperty

function CkXmp_GetProperty(objHandle: HCkXmp;
iXml: HCkXml;
propName: PWideChar): HCkXml; stdcall;

To be documented soon...

Returns nil on failure

GetSimpleInt

function CkXmp_GetSimpleInt(objHandle: HCkXmp;
iXml: HCkXml;
propName: PWideChar): Integer; stdcall;

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

GetSimpleStr

function CkXmp_GetSimpleStr(objHandle: HCkXmp;
    iXml: HCkXml;
    propName: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkXmp__getSimpleStr(objHandle: HCkXmp;
    iXml: HCkXml;
    propName: PWideChar): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Get a String Property Value from XMP

GetStructPropNames

function CkXmp_GetStructPropNames(objHandle: HCkXmp;
iXml: HCkXml;
structName: PWideChar): HCkStringArray; stdcall;

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

GetStructValue

function CkXmp_GetStructValue(objHandle: HCkXmp;
    iXml: HCkXml;
    structName: PWideChar;
    propName: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkXmp__getStructValue(objHandle: HCkXmp;
    iXml: HCkXml;
    structName: PWideChar;
    propName: PWideChar): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Get a Structure Property Value from XMP

LoadAppFile

function CkXmp_LoadAppFile(objHandle: HCkXmp;
filename: PWideChar): wordbool; stdcall;

Loads a TIFF or JPG file into the XMP object.

LoadFromBuffer

function CkXmp_LoadFromBuffer(objHandle: HCkXmp;
fileData: HCkByteData;
ext: PWideChar): wordbool; stdcall;

Loads a JPG or TIFF from an byte buffer containing the image file data.

NewXmp

function CkXmp_NewXmp(objHandle: HCkXmp): HCkXml; stdcall;

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

Returns nil on failure

More Information and Examples

Add XMP MetaData to JPG or TIFF

RemoveAllEmbedded

function CkXmp_RemoveAllEmbedded(objHandle: HCkXmp): wordbool; stdcall;

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.

RemoveArray

function CkXmp_RemoveArray(objHandle: HCkXmp;
iXml: HCkXml;
propName: PWideChar): wordbool; stdcall;

Removes an XMP array property from the XMP document.

RemoveEmbedded

function CkXmp_RemoveEmbedded(objHandle: HCkXmp;
index: Integer): wordbool; stdcall;

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.

RemoveNsMapping

procedure CkXmp_RemoveNsMapping(objHandle: HCkXmp;
ns: PWideChar) stdcall;

Removes a namespace-to-URI mapping.

RemoveSimple

function CkXmp_RemoveSimple(objHandle: HCkXmp;
iXml: HCkXml;
propName: PWideChar): wordbool; stdcall;

Removes a simple XMP property from the XMP document.

RemoveStruct

function CkXmp_RemoveStruct(objHandle: HCkXmp;
iXml: HCkXml;
structName: PWideChar): wordbool; stdcall;

Removes an XMP structure property from the XMP document.

RemoveStructProp

function CkXmp_RemoveStructProp(objHandle: HCkXmp;
    iXml: HCkXml;
    structName: PWideChar;
    propName: PWideChar): wordbool; stdcall;

Removes a single member from an XMP structured property.

SaveAppFile

function CkXmp_SaveAppFile(objHandle: HCkXmp;
filename: PWideChar): wordbool; stdcall;

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.

SaveToBuffer

function CkXmp_SaveToBuffer(objHandle: HCkXmp;
outBytes: HCkByteData): wordbool; stdcall;

Saves a JPG or TIFF image with updated XMP to a byte buffer.

Returns True for success, False for failure.