---
product: Chilkat
product_version: 11.7.0
language: vbnet
language_label: VB.NET
class: Xmp
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/vbnetXmpRef.html
---
# Chilkat Xmp — VB.NET — v11.7.0

> Chilkat 11.7.0 · language=vbnet · 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/vbnet/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**

```vbnet
Dim obj As New Chilkat.Xmp()
```

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 VB.NET.

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` | `DebugLogFilePath As String` | 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` | `LastErrorHtml As String (ReadOnly)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `LastErrorText As String (ReadOnly)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `LastErrorXml As String (ReadOnly)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `LastMethodSuccess As Boolean` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. |
| `VerboseLogging` | `VerboseLogging As Boolean` | read/write | If set to `True`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `Version As String (ReadOnly)` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `NumEmbedded` | property, read-only | `NumEmbedded As Integer (ReadOnly)` |
| `StructInnerDescrip` | property, read/write | `StructInnerDescrip As Boolean` |
| `UncommonOptions` | property, read/write | `UncommonOptions As String` |
| `AddArray` | method | `Function AddArray(ByVal xml As Xml, ByVal arrType As String, ByVal propName As String, ByVal values As StringArray) As Boolean` |
| `AddNsMapping` | method | `Sub AddNsMapping(ByVal ns As String, ByVal uri As String)` |
| `AddSimpleInt` | method | `Function AddSimpleInt(ByVal iXml As Xml, ByVal propName As String, ByVal propVal As Integer) As Boolean` |
| `AddSimpleStr` | method | `Function AddSimpleStr(ByVal iXml As Xml, ByVal propName As String, ByVal propVal As String) As Boolean` |
| `AddStructProp` | method | `Function AddStructProp(ByVal iChilkatXml As Xml, ByVal structName As String, ByVal propName As String, ByVal propValue As String) As Boolean` |
| `Append` | method | `Function Append(ByVal iXml As Xml) As Boolean` |
| `GetArray` | method | `Function GetArray(ByVal iXml As Xml, ByVal propName As String) As StringArray` |
| `GetEmbedded` | method | `Function GetEmbedded(ByVal index As Integer) As Xml` |
| `GetProperty` | method | `Function GetProperty(ByVal iXml As Xml, ByVal propName As String) As Xml` |
| `GetSimpleInt` | method | `Function GetSimpleInt(ByVal iXml As Xml, ByVal propName As String) As Integer` |
| `GetSimpleStr` | method | `Function GetSimpleStr(ByVal iXml As Xml, ByVal propName As String) As String` |
| `GetStructPropNames` | method | `Function GetStructPropNames(ByVal iXml As Xml, ByVal structName As String) As StringArray` |
| `GetStructValue` | method | `Function GetStructValue(ByVal iXml As Xml, ByVal structName As String, ByVal propName As String) As String` |
| `LoadAppFile` | method | `Function LoadAppFile(ByVal filename As String) As Boolean` |
| `LoadFromBuffer` | method | `Function LoadFromBuffer(ByVal fileData As Byte(), ByVal ext As String) As Boolean` |
| `NewXmp` | method | `Function NewXmp() As Xml` |
| `RemoveAllEmbedded` | method | `Function RemoveAllEmbedded() As Boolean` |
| `RemoveArray` | method | `Function RemoveArray(ByVal iXml As Xml, ByVal propName As String) As Boolean` |
| `RemoveEmbedded` | method | `Function RemoveEmbedded(ByVal index As Integer) As Boolean` |
| `RemoveNsMapping` | method | `Sub RemoveNsMapping(ByVal ns As String)` |
| `RemoveSimple` | method | `Function RemoveSimple(ByVal iXml As Xml, ByVal propName As String) As Boolean` |
| `RemoveStruct` | method | `Function RemoveStruct(ByVal iXml As Xml, ByVal structName As String) As Boolean` |
| `RemoveStructProp` | method | `Function RemoveStructProp(ByVal iXml As Xml, ByVal structName As String, ByVal propName As String) As Boolean` |
| `SaveAppFile` | method | `Function SaveAppFile(ByVal filename As String) As Boolean` |
| `SaveToBuffer` | method | `Function SaveToBuffer() As Byte()` |

## Properties

### Xmp.NumEmbedded

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

```vbnet
NumEmbedded As Integer (ReadOnly)
```

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

### Xmp.StructInnerDescrip

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

```vbnet
StructInnerDescrip As Boolean
```

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

### Xmp.UncommonOptions

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

```vbnet
UncommonOptions As String
```

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

## Methods

### Xmp.AddArray

`Chilkat 11.7.0 · vbnet · Xmp · AddArray · method`

```vbnet
Function AddArray(ByVal xml As Xml, ByVal arrType As String, ByVal propName As String, ByVal values As StringArray) 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`.

Returns True for success, False for failure.

### Xmp.AddNsMapping

`Chilkat 11.7.0 · vbnet · Xmp · AddNsMapping · method`

```vbnet
Sub AddNsMapping(ByVal ns As String, ByVal uri As String)
```

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 · vbnet · Xmp · AddSimpleInt · method`

```vbnet
Function AddSimpleInt(ByVal iXml As Xml, ByVal propName As String, ByVal propVal As Integer) 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`.

Returns True for success, False for failure.

### Xmp.AddSimpleStr

`Chilkat 11.7.0 · vbnet · Xmp · AddSimpleStr · method`

```vbnet
Function AddSimpleStr(ByVal iXml As Xml, ByVal propName As String, ByVal propVal As String) 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`.

Returns True for success, False for failure.

### Xmp.AddStructProp

`Chilkat 11.7.0 · vbnet · Xmp · AddStructProp · method`

```vbnet
Function AddStructProp(ByVal iChilkatXml As Xml, ByVal structName As String, ByVal propName As String, ByVal propValue As String) 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`.

Returns True for success, False for failure.

### Xmp.Append

`Chilkat 11.7.0 · vbnet · Xmp · Append · method`

```vbnet
Function Append(ByVal iXml As Xml) 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.

Returns True for success, False for failure.

### Xmp.GetArray

`Chilkat 11.7.0 · vbnet · Xmp · GetArray · method`

```vbnet
Function GetArray(ByVal iXml As Xml, ByVal propName As String) As StringArray
```

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

Returns `Nothing` on failure

### Xmp.GetEmbedded

`Chilkat 11.7.0 · vbnet · Xmp · GetEmbedded · method`

```vbnet
Function GetEmbedded(ByVal index As Integer) As Xml
```

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

Returns `Nothing` on failure

### Xmp.GetProperty

`Chilkat 11.7.0 · vbnet · Xmp · GetProperty · method`

```vbnet
Function GetProperty(ByVal iXml As Xml, ByVal propName As String) As Xml
```

To be documented soon...

Returns `Nothing` on failure

### Xmp.GetSimpleInt

`Chilkat 11.7.0 · vbnet · Xmp · GetSimpleInt · method`

```vbnet
Function GetSimpleInt(ByVal iXml As Xml, ByVal propName As String) As 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 · vbnet · Xmp · GetSimpleStr · method`

```vbnet
Function GetSimpleStr(ByVal iXml As Xml, ByVal propName As String) As String
```

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

Returns `Nothing` on failure

### Xmp.GetStructPropNames

`Chilkat 11.7.0 · vbnet · Xmp · GetStructPropNames · method`

```vbnet
Function GetStructPropNames(ByVal iXml As Xml, ByVal structName As String) As StringArray
```

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 `Nothing` on failure

### Xmp.GetStructValue

`Chilkat 11.7.0 · vbnet · Xmp · GetStructValue · method`

```vbnet
Function GetStructValue(ByVal iXml As Xml, ByVal structName As String, ByVal propName As String) As String
```

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

Returns `Nothing` on failure

### Xmp.LoadAppFile

`Chilkat 11.7.0 · vbnet · Xmp · LoadAppFile · method`

```vbnet
Function LoadAppFile(ByVal filename As String) As Boolean
```

Loads a TIFF or JPG file into the XMP object.

Returns True for success, False for failure.

### Xmp.LoadFromBuffer

`Chilkat 11.7.0 · vbnet · Xmp · LoadFromBuffer · method`

```vbnet
Function LoadFromBuffer(ByVal fileData As Byte(), ByVal ext As String) As Boolean
```

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

### Xmp.NewXmp

`Chilkat 11.7.0 · vbnet · Xmp · NewXmp · method`

```vbnet
Function NewXmp() As Xml
```

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

Returns `Nothing` on failure

### Xmp.RemoveAllEmbedded

`Chilkat 11.7.0 · vbnet · Xmp · RemoveAllEmbedded · method`

```vbnet
Function 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 True for success, False for failure.

### Xmp.RemoveArray

`Chilkat 11.7.0 · vbnet · Xmp · RemoveArray · method`

```vbnet
Function RemoveArray(ByVal iXml As Xml, ByVal propName As String) As Boolean
```

Removes an XMP array property from the XMP document.

Returns True for success, False for failure.

### Xmp.RemoveEmbedded

`Chilkat 11.7.0 · vbnet · Xmp · RemoveEmbedded · method`

```vbnet
Function RemoveEmbedded(ByVal index As Integer) As 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 · vbnet · Xmp · RemoveNsMapping · method`

```vbnet
Sub RemoveNsMapping(ByVal ns As String)
```

Removes a namespace-to-URI mapping.

### Xmp.RemoveSimple

`Chilkat 11.7.0 · vbnet · Xmp · RemoveSimple · method`

```vbnet
Function RemoveSimple(ByVal iXml As Xml, ByVal propName As String) As Boolean
```

Removes a simple XMP property from the XMP document.

Returns True for success, False for failure.

### Xmp.RemoveStruct

`Chilkat 11.7.0 · vbnet · Xmp · RemoveStruct · method`

```vbnet
Function RemoveStruct(ByVal iXml As Xml, ByVal structName As String) As Boolean
```

Removes an XMP structure property from the XMP document.

Returns True for success, False for failure.

### Xmp.RemoveStructProp

`Chilkat 11.7.0 · vbnet · Xmp · RemoveStructProp · method`

```vbnet
Function RemoveStructProp(ByVal iXml As Xml, ByVal structName As String, ByVal propName As String) As Boolean
```

Removes a single member from an XMP structured property.

Returns True for success, False for failure.

### Xmp.SaveAppFile

`Chilkat 11.7.0 · vbnet · Xmp · SaveAppFile · method`

```vbnet
Function SaveAppFile(ByVal filename As String) 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.

Returns True for success, False for failure.

### Xmp.SaveToBuffer

`Chilkat 11.7.0 · vbnet · Xmp · SaveToBuffer · method`

```vbnet
Function SaveToBuffer() As Byte()
```

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

Returns an empty byte array on failure

## Related classes

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

