--- product: Chilkat product_version: 11.7.0 language: dataflex language_label: DataFlex class: Xmp license: bundle deprecated: false reference_html: https://www.chilkatsoft.com/refdoc/dataflexXmpRef.html --- # Chilkat Xmp — DataFlex — v11.7.0 > Chilkat 11.7.0 · language=dataflex · class=Xmp > Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0//classes/Xmp.md`. > Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/dataflex/guide.md`. ## Purpose **Read, modify, add, remove, and save XMP metadata in JPG and TIFF files.** `Chilkat.Xmp` is a legacy class for working with embedded XMP metadata in `JPG` and `TIFF` image files. It can load image files or image data from memory, locate embedded XMP documents, return XMP metadata as `Chilkat.Xml`, create new XMP documents, add or update simple string and integer properties, manage arrays and structured properties, add namespace mappings, remove selected XMP properties or entire embedded XMP documents, and save the updated image back to a file or byte buffer. **Legacy class:** `Chilkat.Xmp` is maintained for existing JPG/TIFF XMP workflows, but it is not planned to be extended to support additional file types. **Load JPG or TIFF metadata** Load a `JPG` or `TIFF` file from disk or memory and inspect how many embedded XMP documents were found. **Access XMP as XML** Retrieve embedded XMP documents as `Chilkat.Xml` objects for inspection, editing, or direct XML-level processing. **Add simple properties** Add or update namespace-qualified string and integer properties such as `dc:subject`, `photoshop:Credit`, or `tiff:XResolution`. **Arrays and structures** Work with XMP arrays such as `bag`, `seq`, and `alt`, and manage structured property values. **Namespaces** Use built-in namespace mappings or add custom namespace-to-URI mappings for application-specific XMP properties. **Remove and save** Remove properties, arrays, structures, or embedded XMP documents, then persist changes to a file or return the updated image as a byte buffer. **Common pattern:** Load a JPG or TIFF with `LoadAppFile` or `LoadFromBuffer`, retrieve an embedded XMP document with `GetEmbedded` or create one with `NewXmp`, modify it using the add/remove property methods, then call `SaveAppFile` or `SaveToBuffer` to persist the updated image metadata. **Persistence note:** Changes made to the XMP XML object are not written back to the image file until `SaveAppFile` is called. For memory workflows, use `SaveToBuffer` to obtain the updated JPG or TIFF bytes. ## Object creation, unlocking and error handling **Object Creation** ```dataflex // (Dataflex programs use the 32-bit Chilkat ActiveX) Handle hoXmp Get Create(RefClass(cComChilkatXmp)) to hoXmp ``` Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in DataFlex. How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called. ## Members common to every Chilkat class Documented once per language in `common-members.md`; listed here so this page is self-contained. | Property | Signature | Access | Meaning | |---|---|---|---| | `DebugLogFilePath` | `Function ComDebugLogFilePath Returns String Procedure Set ComDebugLogFilePath String value` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. | | `LastBinaryResult` | `Function ComLastBinaryResult Returns Variant` | read-only | This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. | | `LastErrorHtml` | `Function ComLastErrorHtml Returns String` | read-only | Provides HTML-formatted information about the last called method or property. | | `LastErrorText` | `Function ComLastErrorText Returns String` | read-only | Provides plain text information about the last called method or property. | | `LastErrorXml` | `Function ComLastErrorXml Returns String` | read-only | Provides XML-formatted information about the last called method or property. | | `LastMethodSuccess` | `Function ComLastMethodSuccess Returns Boolean Procedure Set ComLastMethodSuccess Boolean value` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. | | `LastStringResult` | `Function ComLastStringResult Returns String` | read-only | In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. | | `LastStringResultLen` | `Function ComLastStringResultLen Returns Integer` | read-only | The length, in characters, of the string contained in the LastStringResult property. | | `VerboseLogging` | `Function ComVerboseLogging Returns Boolean Procedure Set ComVerboseLogging Boolean value` | read/write | If set to `True`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. | | `Version` | `Function ComVersion Returns String` | read-only | Version of the component/library, such as "10.1.0" | ## Member index | Member | Kind | Signature | |---|---|---| | `NumEmbedded` | property, read-only | `Function ComNumEmbedded Returns Integer` | | `StructInnerDescrip` | property, read/write | `Function ComStructInnerDescrip Returns Boolean Procedure Set ComStructInnerDescrip Boolean value` | | `UncommonOptions` | property, read/write | `Function ComUncommonOptions Returns String Procedure Set ComUncommonOptions String value` | | `AddArray` | method | `Function ComAddArray cComChilkatXml xml String arrType String propName cComCkStringArray values Returns Boolean` | | `AddNsMapping` | method | `Procedure ComAddNsMapping String ns String uri` | | `AddSimpleInt` | method | `Function ComAddSimpleInt cComChilkatXml iXml String propName Integer propVal Returns Boolean` | | `AddSimpleStr` | method | `Function ComAddSimpleStr cComChilkatXml iXml String propName String propVal Returns Boolean` | | `AddStructProp` | method | `Function ComAddStructProp cComChilkatXml iChilkatXml String structName String propName String propValue Returns Boolean` | | `Append` | method | `Function ComAppend cComChilkatXml iXml Returns Boolean` | | `GetArray` | method | `Function ComGetArray cComChilkatXml iXml String propName Returns cComCkStringArray` | | `GetEmbedded` | method | `Function ComGetEmbedded Integer index Returns cComChilkatXml` | | `GetProperty` | method | `Function ComGetProperty cComChilkatXml iXml String propName Returns cComChilkatXml` | | `GetSimpleInt` | method | `Function ComGetSimpleInt cComChilkatXml iXml String propName Returns Integer` | | `GetSimpleStr` | method | `Function ComGetSimpleStr cComChilkatXml iXml String propName Returns String` | | `GetStructPropNames` | method | `Function ComGetStructPropNames cComChilkatXml iXml String structName Returns cComCkStringArray` | | `GetStructValue` | method | `Function ComGetStructValue cComChilkatXml iXml String structName String propName Returns String` | | `LoadAppFile` | method | `Function ComLoadAppFile String filename Returns Boolean` | | `LoadFromBuffer` | method | `Function ComLoadFromBuffer Variant fileData String ext Returns Boolean` | | `NewXmp` | method | `Function ComNewXmp Returns cComChilkatXml` | | `RemoveAllEmbedded` | method | `Function ComRemoveAllEmbedded Returns Boolean` | | `RemoveArray` | method | `Function ComRemoveArray cComChilkatXml iXml String propName Returns Boolean` | | `RemoveEmbedded` | method | `Function ComRemoveEmbedded Integer index Returns Boolean` | | `RemoveNsMapping` | method | `Procedure ComRemoveNsMapping String ns` | | `RemoveSimple` | method | `Function ComRemoveSimple cComChilkatXml iXml String propName Returns Boolean` | | `RemoveStruct` | method | `Function ComRemoveStruct cComChilkatXml iXml String structName Returns Boolean` | | `RemoveStructProp` | method | `Function ComRemoveStructProp cComChilkatXml iXml String structName String propName Returns Boolean` | | `SaveAppFile` | method | `Function ComSaveAppFile String filename Returns Boolean` | | `SaveToBuffer` | method | `Function ComSaveToBuffer Returns Variant` | ## Properties ### Xmp.NumEmbedded `Chilkat 11.7.0 · dataflex · Xmp · NumEmbedded · property · read-only` ```dataflex Function ComNumEmbedded Returns Integer ``` The number of XMP metadata documents found within the JPG or TIFF file loaded by LoadAppFile. ### Xmp.StructInnerDescrip `Chilkat 11.7.0 · dataflex · Xmp · StructInnerDescrip · property · read/write` ```dataflex Function ComStructInnerDescrip Returns Boolean Procedure Set ComStructInnerDescrip Boolean value ``` Determines whether structures are stored with rdf:parseType=`Resource`, or within an `rdf:Description` sub-node. ### Xmp.UncommonOptions `Chilkat 11.7.0 · dataflex · Xmp · UncommonOptions · property · read/write · since 9.5.0.80` ```dataflex Function ComUncommonOptions Returns String Procedure Set ComUncommonOptions String value ``` A property to be used for future uncommon needs. The default value is the empty string. ## Methods ### Xmp.AddArray `Chilkat 11.7.0 · dataflex · Xmp · AddArray · method` ```dataflex Function ComAddArray cComChilkatXml xml String arrType String propName cComCkStringArray values Returns 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`. Returns True for success, False for failure. ### Xmp.AddNsMapping `Chilkat 11.7.0 · dataflex · Xmp · AddNsMapping · method` ```dataflex Procedure ComAddNsMapping String ns String uri ``` 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. ### Xmp.AddSimpleInt `Chilkat 11.7.0 · dataflex · Xmp · AddSimpleInt · method` ```dataflex Function ComAddSimpleInt cComChilkatXml iXml String propName Integer propVal Returns 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`. Returns True for success, False for failure. ### Xmp.AddSimpleStr `Chilkat 11.7.0 · dataflex · Xmp · AddSimpleStr · method` ```dataflex Function ComAddSimpleStr cComChilkatXml iXml String propName String propVal Returns 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`. Returns True for success, False for failure. ### Xmp.AddStructProp `Chilkat 11.7.0 · dataflex · Xmp · AddStructProp · method` ```dataflex Function ComAddStructProp cComChilkatXml iChilkatXml String structName String propName String propValue Returns 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`. Returns True for success, False for failure. ### Xmp.Append `Chilkat 11.7.0 · dataflex · Xmp · Append · method` ```dataflex Function ComAppend cComChilkatXml iXml Returns 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. Returns True for success, False for failure. ### Xmp.GetArray `Chilkat 11.7.0 · dataflex · Xmp · GetArray · method` ```dataflex Function ComGetArray cComChilkatXml iXml String propName Returns cComCkStringArray ``` Finds and returns an XMP array property. The property name should be prefixed with the namespace, such as `dc:subject`. Returns `null` on failure ### Xmp.GetEmbedded `Chilkat 11.7.0 · dataflex · Xmp · GetEmbedded · method` ```dataflex Function ComGetEmbedded Integer index Returns cComChilkatXml ``` Returns the Nth embedded XMP document as a Chilkat XML object. Returns `null` on failure ### Xmp.GetProperty `Chilkat 11.7.0 · dataflex · Xmp · GetProperty · method` ```dataflex Function ComGetProperty cComChilkatXml iXml String propName Returns cComChilkatXml ``` To be documented soon... Returns `null` on failure ### Xmp.GetSimpleInt `Chilkat 11.7.0 · dataflex · Xmp · GetSimpleInt · method` ```dataflex Function ComGetSimpleInt cComChilkatXml iXml String propName Returns Integer ``` Finds and returns an XMP integer property. The property name should be prefixed with the namespace, such as `tiff:ResolutionUnit`. ### Xmp.GetSimpleStr `Chilkat 11.7.0 · dataflex · Xmp · GetSimpleStr · method` ```dataflex Function ComGetSimpleStr cComChilkatXml iXml String propName Returns String ``` Finds and returns an XMP simple string property. The property name should be prefixed with the namespace, such as `photoshop:Source`. Returns `null` on failure ### Xmp.GetStructPropNames `Chilkat 11.7.0 · dataflex · Xmp · GetStructPropNames · method` ```dataflex Function ComGetStructPropNames cComChilkatXml iXml String structName Returns cComCkStringArray ``` 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 ### Xmp.GetStructValue `Chilkat 11.7.0 · dataflex · Xmp · GetStructValue · method` ```dataflex Function ComGetStructValue cComChilkatXml iXml String structName String propName Returns String ``` Returns the value of a single item within an XMP structure property. Property names should always be prefixed with the namespace. Returns `null` on failure ### Xmp.LoadAppFile `Chilkat 11.7.0 · dataflex · Xmp · LoadAppFile · method` ```dataflex Function ComLoadAppFile String filename Returns Boolean ``` Loads a TIFF or JPG file into the XMP object. Returns True for success, False for failure. ### Xmp.LoadFromBuffer `Chilkat 11.7.0 · dataflex · Xmp · LoadFromBuffer · method` ```dataflex Function ComLoadFromBuffer Variant fileData String ext Returns Boolean ``` Loads a JPG or TIFF from an byte buffer containing the image file data. ### Xmp.NewXmp `Chilkat 11.7.0 · dataflex · Xmp · NewXmp · method` ```dataflex Function ComNewXmp Returns cComChilkatXml ``` Creates and returns a new/empty XMP metadata document as a Chilkat XML object. Returns `null` on failure ### Xmp.RemoveAllEmbedded `Chilkat 11.7.0 · dataflex · Xmp · RemoveAllEmbedded · method` ```dataflex Function ComRemoveAllEmbedded Returns 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 True for success, False for failure. ### Xmp.RemoveArray `Chilkat 11.7.0 · dataflex · Xmp · RemoveArray · method` ```dataflex Function ComRemoveArray cComChilkatXml iXml String propName Returns Boolean ``` Removes an XMP array property from the XMP document. Returns True for success, False for failure. ### Xmp.RemoveEmbedded `Chilkat 11.7.0 · dataflex · Xmp · RemoveEmbedded · method` ```dataflex Function ComRemoveEmbedded Integer index Returns Boolean ``` 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. ### Xmp.RemoveNsMapping `Chilkat 11.7.0 · dataflex · Xmp · RemoveNsMapping · method` ```dataflex Procedure ComRemoveNsMapping String ns ``` Removes a namespace-to-URI mapping. ### Xmp.RemoveSimple `Chilkat 11.7.0 · dataflex · Xmp · RemoveSimple · method` ```dataflex Function ComRemoveSimple cComChilkatXml iXml String propName Returns Boolean ``` Removes a simple XMP property from the XMP document. Returns True for success, False for failure. ### Xmp.RemoveStruct `Chilkat 11.7.0 · dataflex · Xmp · RemoveStruct · method` ```dataflex Function ComRemoveStruct cComChilkatXml iXml String structName Returns Boolean ``` Removes an XMP structure property from the XMP document. Returns True for success, False for failure. ### Xmp.RemoveStructProp `Chilkat 11.7.0 · dataflex · Xmp · RemoveStructProp · method` ```dataflex Function ComRemoveStructProp cComChilkatXml iXml String structName String propName Returns Boolean ``` Removes a single member from an XMP structured property. Returns True for success, False for failure. ### Xmp.SaveAppFile `Chilkat 11.7.0 · dataflex · Xmp · SaveAppFile · method` ```dataflex Function ComSaveAppFile String filename Returns 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. Returns True for success, False for failure. ### Xmp.SaveToBuffer `Chilkat 11.7.0 · dataflex · Xmp · SaveToBuffer · method` ```dataflex Function ComSaveToBuffer Returns Variant ``` Saves a JPG or TIFF image with updated XMP to a byte buffer. Returns `null` on failure ## Related classes [`StringArray`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/dataflex/classes/StringArray.md), [`Xml`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/dataflex/classes/Xml.md)