---
product: Chilkat
product_version: 11.7.0
language: sqlserver
language_label: SQL Server
class: Xmp
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/sqlserver_XmpRef.html
---
# Chilkat Xmp — SQL Server — v11.7.0

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

```sql
DECLARE @hr int
DECLARE @xmp int
EXEC @hr = sp_OACreate 'Chilkat.Xmp', @xmp OUT
IF @hr <> 0
BEGIN
    PRINT 'Failed to create ActiveX component'
    RETURN
END

-- ... use @xmp ...

EXEC @hr = sp_OADestroy @xmp
```

T-SQL uses the Chilkat ActiveX through the OLE Automation stored procedures. They must be enabled once on the server (`EXEC sp_configure 'Ole Automation Procedures', 1; RECONFIGURE;`), and the Chilkat ActiveX registered must match the bitness of the SQL Server instance (64-bit for a 64-bit SQL Server). To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `sp_OACreate 'Chilkat.Xmp.11'` for Chilkat v11.\*.\*.

`sp_OACreate` returns an object token (an `int`) that is passed as the first argument of every `sp_OAMethod`, `sp_OAGetProperty` and `sp_OASetProperty` call, and released with `sp_OADestroy`. Objects returned by methods (such as an `HttpResponse` or `JsonObject`) are also tokens received through an `int` OUT parameter; they must likewise be destroyed, and the OUT parameter is `NULL` when the method fails to return an object. Objects passed as arguments are passed by their token. When an OLE Automation procedure itself fails (non-zero `@hr`), `sp_OAGetErrorInfo` describes the error.

Data types: strings are `nvarchar(4000)`; integers, booleans (1 or 0) and object tokens are `int`; dates are `datetime`. In the signatures on this page, `@success`, `@iResult`, `@sResult` and the like are the OUT variables receiving a method's return value, `@iValue` / `@sValue` receive or supply a property value, and the remaining `@` variables are the method's arguments in order.

A string returned through an OUT parameter is limited to 4000 characters. For longer values, retrieve the result as a result set into a table variable instead of an OUT parameter, for example `DECLARE @tmp TABLE (outputLine ntext)` followed by `INSERT INTO @tmp EXEC sp_OAGetProperty @xmp, 'LastErrorText'`. See [string length limitations for strings returned by sp_OAMethod calls](https://www.chilkatsoft.com/sql_server_nvarchar_max_limitation.asp).

Methods that pass or return raw byte arrays are not shown on this page, because `varbinary(max)` values cannot be exchanged through `sp_OAMethod` (see [varbinary(max) limitation](https://www.chilkatsoft.com/sql_server_varbinary_max_limitation.asp)). Use the `BinData`-based alternatives (methods ending in *Bd*) or the base64 / hex string-encoded variants instead. Binary *properties* (such as `LastBinaryResult`) can be retrieved as a result set into a table variable, as shown in their signatures. Asynchronous (*\*Async*) methods and event callbacks are not available from SQL Server.

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 SQL Server.

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` | `EXEC sp_OAGetProperty @xmp, 'DebugLogFilePath', @sValue OUT EXEC sp_OASetProperty @xmp, 'DebugLogFilePath', @sValue` | 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` | `INSERT INTO @tmp EXEC sp_OAGetProperty @xmp, 'LastBinaryResult'` | 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` | `EXEC sp_OAGetProperty @xmp, 'LastErrorHtml', @sValue OUT` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `EXEC sp_OAGetProperty @xmp, 'LastErrorText', @sValue OUT` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `EXEC sp_OAGetProperty @xmp, 'LastErrorXml', @sValue OUT` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `EXEC sp_OAGetProperty @xmp, 'LastMethodSuccess', @iValue OUT EXEC sp_OASetProperty @xmp, 'LastMethodSuccess', @iValue` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `EXEC sp_OAGetProperty @xmp, 'LastStringResult', @sValue OUT` | 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` | `EXEC sp_OAGetProperty @xmp, 'LastStringResultLen', @iValue OUT` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `EXEC sp_OAGetProperty @xmp, 'VerboseLogging', @iValue OUT EXEC sp_OASetProperty @xmp, 'VerboseLogging', @iValue` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `EXEC sp_OAGetProperty @xmp, 'Version', @sValue OUT` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `NumEmbedded` | property, read-only | `EXEC sp_OAGetProperty @xmp, 'NumEmbedded', @iValue OUT` |
| `StructInnerDescrip` | property, read/write | `EXEC sp_OAGetProperty @xmp, 'StructInnerDescrip', @iValue OUT EXEC sp_OASetProperty @xmp, 'StructInnerDescrip', @iValue` |
| `UncommonOptions` | property, read/write | `EXEC sp_OAGetProperty @xmp, 'UncommonOptions', @sValue OUT EXEC sp_OASetProperty @xmp, 'UncommonOptions', @sValue` |
| `AddArray` | method | `EXEC sp_OAMethod @xmp, 'AddArray', @success OUT, @xml, @arrType, @propName, @values` |
| `AddNsMapping` | method | `EXEC sp_OAMethod @xmp, 'AddNsMapping', NULL, @ns, @uri` |
| `AddSimpleInt` | method | `EXEC sp_OAMethod @xmp, 'AddSimpleInt', @success OUT, @iXml, @propName, @propVal` |
| `AddSimpleStr` | method | `EXEC sp_OAMethod @xmp, 'AddSimpleStr', @success OUT, @iXml, @propName, @propVal` |
| `AddStructProp` | method | `EXEC sp_OAMethod @xmp, 'AddStructProp', @success OUT, @iChilkatXml, @structName, @propName, @propValue` |
| `Append` | method | `EXEC sp_OAMethod @xmp, 'Append', @success OUT, @iXml` |
| `GetArray` | method | `EXEC sp_OAMethod @xmp, 'GetArray', @stringArray OUT, @iXml, @propName -- returns a CkStringArray object token` |
| `GetEmbedded` | method | `EXEC sp_OAMethod @xmp, 'GetEmbedded', @xml OUT, @index -- returns a ChilkatXml object token` |
| `GetProperty` | method | `EXEC sp_OAMethod @xmp, 'GetProperty', @xml OUT, @iXml, @propName -- returns a ChilkatXml object token` |
| `GetSimpleInt` | method | `EXEC sp_OAMethod @xmp, 'GetSimpleInt', @iResult OUT, @iXml, @propName` |
| `GetSimpleStr` | method | `EXEC sp_OAMethod @xmp, 'GetSimpleStr', @sResult OUT, @iXml, @propName` |
| `GetStructPropNames` | method | `EXEC sp_OAMethod @xmp, 'GetStructPropNames', @stringArray OUT, @iXml, @structName -- returns a CkStringArray object token` |
| `GetStructValue` | method | `EXEC sp_OAMethod @xmp, 'GetStructValue', @sResult OUT, @iXml, @structName, @propName` |
| `LoadAppFile` | method | `EXEC sp_OAMethod @xmp, 'LoadAppFile', @success OUT, @filename` |
| `NewXmp` | method | `EXEC sp_OAMethod @xmp, 'NewXmp', @xml OUT -- returns a ChilkatXml object token` |
| `RemoveAllEmbedded` | method | `EXEC sp_OAMethod @xmp, 'RemoveAllEmbedded', @success OUT` |
| `RemoveArray` | method | `EXEC sp_OAMethod @xmp, 'RemoveArray', @success OUT, @iXml, @propName` |
| `RemoveEmbedded` | method | `EXEC sp_OAMethod @xmp, 'RemoveEmbedded', @success OUT, @index` |
| `RemoveNsMapping` | method | `EXEC sp_OAMethod @xmp, 'RemoveNsMapping', NULL, @ns` |
| `RemoveSimple` | method | `EXEC sp_OAMethod @xmp, 'RemoveSimple', @success OUT, @iXml, @propName` |
| `RemoveStruct` | method | `EXEC sp_OAMethod @xmp, 'RemoveStruct', @success OUT, @iXml, @structName` |
| `RemoveStructProp` | method | `EXEC sp_OAMethod @xmp, 'RemoveStructProp', @success OUT, @iXml, @structName, @propName` |
| `SaveAppFile` | method | `EXEC sp_OAMethod @xmp, 'SaveAppFile', @success OUT, @filename` |

## Properties

### Xmp.NumEmbedded

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

```sql
EXEC sp_OAGetProperty @xmp, 'NumEmbedded', @iValue OUT
```

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

### Xmp.StructInnerDescrip

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

```sql
EXEC sp_OAGetProperty @xmp, 'StructInnerDescrip', @iValue OUT
EXEC sp_OASetProperty @xmp, 'StructInnerDescrip', @iValue
```

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

### Xmp.UncommonOptions

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

```sql
EXEC sp_OAGetProperty @xmp, 'UncommonOptions', @sValue OUT
EXEC sp_OASetProperty @xmp, 'UncommonOptions', @sValue
```

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

## Methods

### Xmp.AddArray

`Chilkat 11.7.0 · sqlserver · Xmp · AddArray · method`

```sql
EXEC sp_OAMethod @xmp, 'AddArray', @success OUT, @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 · sqlserver · Xmp · AddNsMapping · method`

```sql
EXEC sp_OAMethod @xmp, 'AddNsMapping', NULL, @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 · sqlserver · Xmp · AddSimpleInt · method`

```sql
EXEC sp_OAMethod @xmp, 'AddSimpleInt', @success OUT, @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 · sqlserver · Xmp · AddSimpleStr · method`

```sql
EXEC sp_OAMethod @xmp, 'AddSimpleStr', @success OUT, @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 · sqlserver · Xmp · AddStructProp · method`

```sql
EXEC sp_OAMethod @xmp, 'AddStructProp', @success OUT, @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 · sqlserver · Xmp · Append · method`

```sql
EXEC sp_OAMethod @xmp, 'Append', @success OUT, @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 · sqlserver · Xmp · GetArray · method`

```sql
EXEC sp_OAMethod @xmp, 'GetArray', @stringArray OUT, @iXml, @propName  -- returns a CkStringArray object token
```

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

```sql
EXEC sp_OAMethod @xmp, 'GetEmbedded', @xml OUT, @index  -- returns a ChilkatXml object token
```

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

Returns `NULL` on failure

### Xmp.GetProperty

`Chilkat 11.7.0 · sqlserver · Xmp · GetProperty · method`

```sql
EXEC sp_OAMethod @xmp, 'GetProperty', @xml OUT, @iXml, @propName  -- returns a ChilkatXml object token
```

To be documented soon...

Returns `NULL` on failure

### Xmp.GetSimpleInt

`Chilkat 11.7.0 · sqlserver · Xmp · GetSimpleInt · method`

```sql
EXEC sp_OAMethod @xmp, 'GetSimpleInt', @iResult OUT, @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 · sqlserver · Xmp · GetSimpleStr · method`

```sql
EXEC sp_OAMethod @xmp, 'GetSimpleStr', @sResult OUT, @iXml, @propName
```

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 · sqlserver · Xmp · GetStructPropNames · method`

```sql
EXEC sp_OAMethod @xmp, 'GetStructPropNames', @stringArray OUT, @iXml, @structName  -- returns a CkStringArray object token
```

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

```sql
EXEC sp_OAMethod @xmp, 'GetStructValue', @sResult OUT, @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 `NULL` on failure

### Xmp.LoadAppFile

`Chilkat 11.7.0 · sqlserver · Xmp · LoadAppFile · method`

```sql
EXEC sp_OAMethod @xmp, 'LoadAppFile', @success OUT, @filename
```

Loads a TIFF or JPG file into the XMP object.

Returns 1 for success, 0 for failure.

### Xmp.NewXmp

`Chilkat 11.7.0 · sqlserver · Xmp · NewXmp · method`

```sql
EXEC sp_OAMethod @xmp, 'NewXmp', @xml OUT  -- returns a ChilkatXml object token
```

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

Returns `NULL` on failure

### Xmp.RemoveAllEmbedded

`Chilkat 11.7.0 · sqlserver · Xmp · RemoveAllEmbedded · method`

```sql
EXEC sp_OAMethod @xmp, 'RemoveAllEmbedded', @success OUT
```

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 · sqlserver · Xmp · RemoveArray · method`

```sql
EXEC sp_OAMethod @xmp, 'RemoveArray', @success OUT, @iXml, @propName
```

Removes an XMP array property from the XMP document.

Returns 1 for success, 0 for failure.

### Xmp.RemoveEmbedded

`Chilkat 11.7.0 · sqlserver · Xmp · RemoveEmbedded · method`

```sql
EXEC sp_OAMethod @xmp, 'RemoveEmbedded', @success OUT, @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 · sqlserver · Xmp · RemoveNsMapping · method`

```sql
EXEC sp_OAMethod @xmp, 'RemoveNsMapping', NULL, @ns
```

Removes a namespace-to-URI mapping.

### Xmp.RemoveSimple

`Chilkat 11.7.0 · sqlserver · Xmp · RemoveSimple · method`

```sql
EXEC sp_OAMethod @xmp, 'RemoveSimple', @success OUT, @iXml, @propName
```

Removes a simple XMP property from the XMP document.

Returns 1 for success, 0 for failure.

### Xmp.RemoveStruct

`Chilkat 11.7.0 · sqlserver · Xmp · RemoveStruct · method`

```sql
EXEC sp_OAMethod @xmp, 'RemoveStruct', @success OUT, @iXml, @structName
```

Removes an XMP structure property from the XMP document.

Returns 1 for success, 0 for failure.

### Xmp.RemoveStructProp

`Chilkat 11.7.0 · sqlserver · Xmp · RemoveStructProp · method`

```sql
EXEC sp_OAMethod @xmp, 'RemoveStructProp', @success OUT, @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 · sqlserver · Xmp · SaveAppFile · method`

```sql
EXEC sp_OAMethod @xmp, 'SaveAppFile', @success OUT, @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.

## Related classes

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

