Xmp SQL Server Reference Documentation
Xmp
Current Version: 11.6.0
Chilkat.Xmp
Load a
Retrieve embedded XMP documents as
Add or update namespace-qualified string and integer properties such as
Work with XMP arrays such as
Use built-in namespace mappings or add custom namespace-to-URI mappings
for application-specific XMP properties.
Remove properties, arrays, structures, or embedded XMP documents, then
persist changes to a file or return the updated image as a byte buffer.
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.
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
JPG or TIFF file from disk or memory and
inspect how many embedded XMP documents were found.
Access XMP as XML
Chilkat.Xml objects for
inspection, editing, or direct XML-level processing.
Add simple properties
dc:subject, photoshop:Credit, or
tiff:XResolution.
Arrays and structures
bag, seq, and
alt, and manage structured property values.
Namespaces
Remove and save
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.
SaveAppFile is called. For memory workflows, use
SaveToBuffer to obtain the updated JPG or TIFF bytes.
Object Creation
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 @xmpT-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.
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). 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.
Properties
DebugLogFilePath
EXEC sp_OASetProperty @xmp, 'DebugLogFilePath', @sValue
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.
LastBinaryResult
This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.
LastErrorHtml
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.
topLastErrorText
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.
LastErrorXml
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.
topLastMethodSuccess
EXEC sp_OASetProperty @xmp, 'LastMethodSuccess', @iValue
Indicates the success or failure of the most recent method call: 1 means success, 0 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. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
LastStringResult
In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.
LastStringResultLen
The length, in characters, of the string contained in the LastStringResult property.
topNumEmbedded
The number of XMP metadata documents found within the JPG or TIFF file loaded by LoadAppFile.
topStructInnerDescrip
EXEC sp_OASetProperty @xmp, 'StructInnerDescrip', @iValue
Determines whether structures are stored with rdf:parseType=Resource, or within an rdf:Description sub-node.
UncommonOptions
EXEC sp_OASetProperty @xmp, 'UncommonOptions', @sValue
A property to be used for future uncommon needs. The default value is the empty string.
topVerboseLogging
EXEC sp_OASetProperty @xmp, 'VerboseLogging', @iValue
If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
Methods
AddArray
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.
AddNsMapping
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.
topAddSimpleInt
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
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
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
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.
topGetArray
Finds and returns an XMP array property. The property name should be prefixed with the namespace, such as dc:subject.
Returns NULL on failure
GetEmbedded
Returns the Nth embedded XMP document as a Chilkat XML object.
Returns NULL on failure
GetProperty
GetSimpleInt
Finds and returns an XMP integer property. The property name should be prefixed with the namespace, such as tiff:ResolutionUnit.
GetSimpleStr
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
GetStructPropNames
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
GetStructValue
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
LoadAppFile
Loads a TIFF or JPG file into the XMP object.
topNewXmp
Creates and returns a new/empty XMP metadata document as a Chilkat XML object.
Returns NULL on failure
RemoveAllEmbedded
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.
topRemoveArray
Removes an XMP array property from the XMP document.
topRemoveEmbedded
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.
topRemoveNsMapping
Removes a namespace-to-URI mapping.
topRemoveSimple
Removes a simple XMP property from the XMP document.
topRemoveStruct
Removes an XMP structure property from the XMP document.
topRemoveStructProp
Removes a single member from an XMP structured property.
topSaveAppFile
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.
top