---
product: Chilkat
product_version: 11.7.0
language: tcl
language_label: Tcl
class: Xmp
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/tclXmpRef.html
---
# Chilkat Xmp — Tcl — v11.7.0

> Chilkat 11.7.0 · language=tcl · class=Xmp
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/Xmp.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/tcl/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**

```tcl
# 'this' is not a keyword in Tcl. It can freely be used as a variable name.
set this [new CkXmp]
```

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

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` | `string # ckStr is a CkString CkXmp_get_DebugLogFilePath $this $ckStr set strVal [CkXmp_get_debugLogFilePath $this] CkXmp_put_DebugLogFilePath $this $strVal` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `string # ckStr is a CkString CkXmp_get_LastErrorHtml $this $ckStr set strVal [CkXmp_get_lastErrorHtml $this]` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `string # ckStr is a CkString CkXmp_get_LastErrorText $this $ckStr set strVal [CkXmp_get_lastErrorText $this]` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `string # ckStr is a CkString CkXmp_get_LastErrorXml $this $ckStr set strVal [CkXmp_get_lastErrorXml $this]` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `boolean 1/0 set boolVal [CkXmp_get_LastMethodSuccess $this] CkXmp_put_LastMethodSuccess $this $boolVal` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `Utf8` | `boolean 1/0 set boolVal [CkXmp_get_Utf8 $this] CkXmp_put_Utf8 $this $boolVal` | read/write | When set to `1`, all `string` arguments and return values are interpreted as UTF-8 strings. |
| `VerboseLogging` | `boolean 1/0 set boolVal [CkXmp_get_VerboseLogging $this] CkXmp_put_VerboseLogging $this $boolVal` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `string # ckStr is a CkString CkXmp_get_Version $this $ckStr set strVal [CkXmp_get_version $this]` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `NumEmbedded` | property, read-only | `integer set intVal [CkXmp_get_NumEmbedded $this]` |
| `StructInnerDescrip` | property, read/write | `boolean 1/0 set boolVal [CkXmp_get_StructInnerDescrip $this] CkXmp_put_StructInnerDescrip $this $boolVal` |
| `UncommonOptions` | property, read/write | `string # ckStr is a CkString CkXmp_get_UncommonOptions $this $ckStr set strVal [CkXmp_get_uncommonOptions $this] CkXmp_put_UncommonOptions $this $strVal` |
| `AddArray` | method | `# xml is a CkXml # arrType is a string # propName is a string # values is a CkStringArray set status [CkXmp_AddArray $this $xml $arrType $propName $values]` |
| `AddNsMapping` | method | `# ns is a string # uri is a string CkXmp_AddNsMapping $this $ns $uri` |
| `AddSimpleInt` | method | `# iXml is a CkXml # propName is a string # propVal is an integer set status [CkXmp_AddSimpleInt $this $iXml $propName $propVal]` |
| `AddSimpleStr` | method | `# iXml is a CkXml # propName is a string # propVal is a string set status [CkXmp_AddSimpleStr $this $iXml $propName $propVal]` |
| `AddStructProp` | method | `# iChilkatXml is a CkXml # structName is a string # propName is a string # propValue is a string set status [CkXmp_AddStructProp $this $iChilkatXml $structName $propName $propValue]` |
| `Append` | method | `# iXml is a CkXml set status [CkXmp_Append $this $iXml]` |
| `GetArray` | method | `# returns a CkStringArray # iXml is a CkXml # propName is a string set ret_stringArray [CkXmp_GetArray $this $iXml $propName]` |
| `GetEmbedded` | method | `# returns a CkXml # index is an integer set ret_xml [CkXmp_GetEmbedded $this $index]` |
| `GetProperty` | method | `# returns a CkXml # iXml is a CkXml # propName is a string set ret_xml [CkXmp_GetProperty $this $iXml $propName]` |
| `GetSimpleInt` | method | `# iXml is a CkXml # propName is a string set retInt [CkXmp_GetSimpleInt $this $iXml $propName]` |
| `GetSimpleStr` | method | `# iXml is a CkXml # propName is a string # outStr is a CkString (output) set status [CkXmp_GetSimpleStr $this $iXml $propName $outStr] set retStr [CkXmp_getSimpleStr $this $iXml $propName]` |
| `GetStructPropNames` | method | `# returns a CkStringArray # iXml is a CkXml # structName is a string set ret_stringArray [CkXmp_GetStructPropNames $this $iXml $structName]` |
| `GetStructValue` | method | `# iXml is a CkXml # structName is a string # propName is a string # outStr is a CkString (output) set status [CkXmp_GetStructValue $this $iXml $structName $propName $outStr] set retStr [CkXmp_getStructValue $this $iXml $structName $propName]` |
| `LoadAppFile` | method | `# filename is a string set status [CkXmp_LoadAppFile $this $filename]` |
| `NewXmp` | method | `# returns a CkXml set ret_xml [CkXmp_NewXmp $this]` |
| `RemoveAllEmbedded` | method | `set status [CkXmp_RemoveAllEmbedded $this]` |
| `RemoveArray` | method | `# iXml is a CkXml # propName is a string set status [CkXmp_RemoveArray $this $iXml $propName]` |
| `RemoveEmbedded` | method | `# index is an integer set status [CkXmp_RemoveEmbedded $this $index]` |
| `RemoveNsMapping` | method | `# ns is a string CkXmp_RemoveNsMapping $this $ns` |
| `RemoveSimple` | method | `# iXml is a CkXml # propName is a string set status [CkXmp_RemoveSimple $this $iXml $propName]` |
| `RemoveStruct` | method | `# iXml is a CkXml # structName is a string set status [CkXmp_RemoveStruct $this $iXml $structName]` |
| `RemoveStructProp` | method | `# iXml is a CkXml # structName is a string # propName is a string set status [CkXmp_RemoveStructProp $this $iXml $structName $propName]` |
| `SaveAppFile` | method | `# filename is a string set status [CkXmp_SaveAppFile $this $filename]` |

Deprecated members are listed at the end of this file with their replacements; do not use them in new code.

## Properties

### Xmp.NumEmbedded

`Chilkat 11.7.0 · tcl · Xmp · NumEmbedded · property · read-only`

```tcl
integer
set intVal [CkXmp_get_NumEmbedded $this]
```

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

### Xmp.StructInnerDescrip

`Chilkat 11.7.0 · tcl · Xmp · StructInnerDescrip · property · read/write`

```tcl
boolean 1/0
set boolVal [CkXmp_get_StructInnerDescrip $this]

CkXmp_put_StructInnerDescrip $this $boolVal
```

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

### Xmp.UncommonOptions

`Chilkat 11.7.0 · tcl · Xmp · UncommonOptions · property · read/write · since 9.5.0.80`

```tcl
string
# ckStr is a CkString

CkXmp_get_UncommonOptions $this $ckStr

set strVal [CkXmp_get_uncommonOptions $this]

CkXmp_put_UncommonOptions $this $strVal
```

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

## Methods

### Xmp.AddArray

`Chilkat 11.7.0 · tcl · Xmp · AddArray · method`

```tcl
# xml is a CkXml

# arrType is a string

# propName is a string

# values is a CkStringArray

set status [CkXmp_AddArray $this $xml  $arrType  $propName  $values]
```

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

### Xmp.AddNsMapping

`Chilkat 11.7.0 · tcl · Xmp · AddNsMapping · method`

```tcl
# ns is a string

# uri is a string

CkXmp_AddNsMapping $this $ns  $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 · tcl · Xmp · AddSimpleInt · method`

```tcl
# iXml is a CkXml

# propName is a string

# propVal is an integer

set status [CkXmp_AddSimpleInt $this $iXml  $propName  $propVal]
```

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

### Xmp.AddSimpleStr

`Chilkat 11.7.0 · tcl · Xmp · AddSimpleStr · method`

```tcl
# iXml is a CkXml

# propName is a string

# propVal is a string

set status [CkXmp_AddSimpleStr $this $iXml  $propName  $propVal]
```

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

### Xmp.AddStructProp

`Chilkat 11.7.0 · tcl · Xmp · AddStructProp · method`

```tcl
# iChilkatXml is a CkXml

# structName is a string

# propName is a string

# propValue is a string

set status [CkXmp_AddStructProp $this $iChilkatXml  $structName  $propName  $propValue]
```

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

### Xmp.Append

`Chilkat 11.7.0 · tcl · Xmp · Append · method`

```tcl
# iXml is a CkXml

set status [CkXmp_Append $this $iXml]
```

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

### Xmp.GetArray

`Chilkat 11.7.0 · tcl · Xmp · GetArray · method`

```tcl
# returns a CkStringArray

# iXml is a CkXml

# propName is a string

set ret_stringArray [CkXmp_GetArray $this $iXml  $propName]
```

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 · tcl · Xmp · GetEmbedded · method`

```tcl
# returns a CkXml

# index is an integer

set ret_xml [CkXmp_GetEmbedded $this $index]
```

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

Returns `NULL` on failure

### Xmp.GetProperty

`Chilkat 11.7.0 · tcl · Xmp · GetProperty · method`

```tcl
# returns a CkXml

# iXml is a CkXml

# propName is a string

set ret_xml [CkXmp_GetProperty $this $iXml  $propName]
```

To be documented soon...

Returns `NULL` on failure

### Xmp.GetSimpleInt

`Chilkat 11.7.0 · tcl · Xmp · GetSimpleInt · method`

```tcl
# iXml is a CkXml

# propName is a string

set retInt [CkXmp_GetSimpleInt $this $iXml  $propName]
```

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 · tcl · Xmp · GetSimpleStr · method`

```tcl
# iXml is a CkXml

# propName is a string

# outStr is a CkString (output)

set status [CkXmp_GetSimpleStr $this $iXml  $propName $outStr]

set retStr [CkXmp_getSimpleStr $this $iXml $propName]
```

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

Returns 1 for success, 0 for failure.

### Xmp.GetStructPropNames

`Chilkat 11.7.0 · tcl · Xmp · GetStructPropNames · method`

```tcl
# returns a CkStringArray

# iXml is a CkXml

# structName is a string

set ret_stringArray [CkXmp_GetStructPropNames $this $iXml  $structName]
```

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 · tcl · Xmp · GetStructValue · method`

```tcl
# iXml is a CkXml

# structName is a string

# propName is a string

# outStr is a CkString (output)

set status [CkXmp_GetStructValue $this $iXml  $structName  $propName $outStr]

set retStr [CkXmp_getStructValue $this $iXml $structName $propName]
```

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

Returns 1 for success, 0 for failure.

### Xmp.LoadAppFile

`Chilkat 11.7.0 · tcl · Xmp · LoadAppFile · method`

```tcl
# filename is a string

set status [CkXmp_LoadAppFile $this $filename]
```

Loads a TIFF or JPG file into the XMP object.

Returns 1 for success, 0 for failure.

### Xmp.NewXmp

`Chilkat 11.7.0 · tcl · Xmp · NewXmp · method`

```tcl
# returns a CkXml

set ret_xml [CkXmp_NewXmp $this]
```

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

Returns `NULL` on failure

### Xmp.RemoveAllEmbedded

`Chilkat 11.7.0 · tcl · Xmp · RemoveAllEmbedded · method`

```tcl
set status [CkXmp_RemoveAllEmbedded $this]
```

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.

### Xmp.RemoveArray

`Chilkat 11.7.0 · tcl · Xmp · RemoveArray · method`

```tcl
# iXml is a CkXml

# propName is a string

set status [CkXmp_RemoveArray $this $iXml  $propName]
```

Removes an XMP array property from the XMP document.

Returns 1 for success, 0 for failure.

### Xmp.RemoveEmbedded

`Chilkat 11.7.0 · tcl · Xmp · RemoveEmbedded · method`

```tcl
# index is an integer

set status [CkXmp_RemoveEmbedded $this $index]
```

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.

### Xmp.RemoveNsMapping

`Chilkat 11.7.0 · tcl · Xmp · RemoveNsMapping · method`

```tcl
# ns is a string

CkXmp_RemoveNsMapping $this $ns
```

Removes a namespace-to-URI mapping.

### Xmp.RemoveSimple

`Chilkat 11.7.0 · tcl · Xmp · RemoveSimple · method`

```tcl
# iXml is a CkXml

# propName is a string

set status [CkXmp_RemoveSimple $this $iXml  $propName]
```

Removes a simple XMP property from the XMP document.

Returns 1 for success, 0 for failure.

### Xmp.RemoveStruct

`Chilkat 11.7.0 · tcl · Xmp · RemoveStruct · method`

```tcl
# iXml is a CkXml

# structName is a string

set status [CkXmp_RemoveStruct $this $iXml  $structName]
```

Removes an XMP structure property from the XMP document.

Returns 1 for success, 0 for failure.

### Xmp.RemoveStructProp

`Chilkat 11.7.0 · tcl · Xmp · RemoveStructProp · method`

```tcl
# iXml is a CkXml

# structName is a string

# propName is a string

set status [CkXmp_RemoveStructProp $this $iXml  $structName  $propName]
```

Removes a single member from an XMP structured property.

Returns 1 for success, 0 for failure.

### Xmp.SaveAppFile

`Chilkat 11.7.0 · tcl · Xmp · SaveAppFile · method`

```tcl
# filename is a string

set status [CkXmp_SaveAppFile $this $filename]
```

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

## Deprecated members — do not use in new code

| Member | Kind | Deprecated in | Use instead |
|---|---|---|---|
| `LoadFromBuffer` | method | before 11.6.1 | — |
| `SaveToBuffer` | method | before 11.6.1 | — |

## Related classes

[`StringArray`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/tcl/classes/StringArray.md), [`Xml`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/tcl/classes/Xml.md)

