ChilkatXmp ActiveX Reference
ChilkatXmp
Chilkat XMP is a software component (SDK, toolkit, library, etc) for accessing, manipulating, and adding XMP metadata to JPEG and TIFF files.
Object Creation
(Visual Basic 6.0)
Dim obj As New ChilkatXmp
(ASP)
set obj = Server.CreateObject("Chilkat.Xmp")
(VBScript)
set obj = CreateObject("Chilkat.Xmp")
(Delphi)
obj := TChilkatXmp.Create(Self);
(FoxPro)
loObject = CreateObject('Chilkat.Xmp')
(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat.Xmp', @obj OUT
(Javascript)
var obj = new ActiveXObject("Chilkat.Xmp");
Properties
DebugLogFilePath As String
If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.
This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes).
A hang or crash should generally never happen. The typical causes of a hang are:
(1) a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
(2) the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
(3) there is an internal problem (bug) in the Chilkat code that causes the hang.
LastErrorHtml As String (read-only)
Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
LastErrorText As String (read-only)
Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.Concept of LastErrorText LastErrorText Standard Information
LastErrorXml As String (read-only)
Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
NumEmbedded As Long (read-only)
The number of XMP metadata documents found within the JPG or TIFF file loaded by LoadAppFile.
StructInnerDescrip As Long
Determines whether structures are stored with rdf:parseType="Resource", or within an "rdf:Description" sub-node.
VerboseLogging As Long
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 As String (read-only)
The version, such as "1.0" of the XMP toolkit.
Methods
AddArray(xml As ChilkatXml, arrType As String, propName As String, values As CkStringArray) As Long
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(ns As String, 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.
AddSimpleDate(iXml As ChilkatXml, propName As String, propVal As Date) As Long
Adds or replaces an XMP date 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 "xap:CreateDate".
AddSimpleInt(iXml As ChilkatXml, propName As String, propVal As Long) As Long
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(iXml As ChilkatXml, propName As String, propVal As String) As Long
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(iChilkatXml As ChilkatXml, structName As String, propName As String, propValue As String) As Long
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(iXml As ChilkatXml) As Long
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.
DateToString(d As Date) As String
Converts a date to a string representation. This method is added for convenience (just in case date-to-string conversions are required). Returns a null on failure
GetArray(iXml As ChilkatXml, propName As String) As CkStringArray
Finds and returns an XMP array property. The property name should be prefixed with the namespace, such as "dc:subject". Returns a null reference on failure
GetEmbedded(index As Long) As ChilkatXml
Returns the Nth embedded XMP document as a Chilkat XML object.
GetProperty(iXml As ChilkatXml, propName As String) As ChilkatXml
To be documented soon...
GetSimpleDate(iXml As ChilkatXml, propName As String) As Date
Finds and returns an XMP date property. The property name should be prefixed with the namespace, such as "xap:ModifyDate".
GetSimpleInt(iXml As ChilkatXml, propName As String) As Long
Finds and returns an XMP integer property. The property name should be prefixed with the namespace, such as "tiff:ResolutionUnit".
GetSimpleStr(iXml As ChilkatXml, 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 a null on failure
GetStructPropNames(iXml As ChilkatXml, structName As String) As CkStringArray
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 a null reference on failure
GetStructValue(iXml As ChilkatXml, structName As String, 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 a null on failure
LoadAppFile(filename As String) As Long
Loads a TIFF or JPG file into the XMP object.
LoadFromBuffer(fileData As Variant, ext As String) As Long
Loads a JPG or TIFF from an byte buffer containing the image file data.
NewCkStringArray() As CkStringArray
To be documented soon...
NewXmp() As ChilkatXml
Creates and returns a new/empty XMP metadata document as a Chilkat XML object.
RemoveAllEmbedded() As Long
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.
RemoveArray(iXml As ChilkatXml, propName As String) As Long
Removes an XMP array property from the XMP document.
RemoveEmbedded(index As Long) As Long
Removes a single XMP metadata document from the JPG or TIFF file. Call SaveAppFile to persist the changes to disk.
RemoveNsMapping(ns As String)
Removes a namespace-to-URI mapping.
RemoveSimple(iXml As ChilkatXml, propName As String) As Long
Removes a simple XMP property from the XMP document.
RemoveStruct(iXml As ChilkatXml, structName As String) As Long
Removes an XMP structure property from the XMP document.
RemoveStructProp(iXml As ChilkatXml, structName As String, propName As String) As Long
Removes a single member from an XMP structured property.
SaveAppFile(filename As String) As Long
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.
SaveLastError(logFilename As String) As Long
Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.
SaveToBuffer() As Variant
Saves a JPG or TIFF image with updated XMP to a byte buffer. Returns a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.
StringToDate(str As String) As Date
Converts a string to a date value. This method is added for convenience (just in case string-to-date conversions are required).
UnlockComponent(unlockCode As String) As Long
Unlocks the XMP component at runtime. This must be called once at the beginning of your application. Passing an arbitrary value initiates a fully-functional 30-day trial. A permanent unlock code is required to use the component beyond 30 days. Diagnosing UnlockComponent Problems UnlockComponent LastErrorText shows exact string passed to it. Verify UnlockComponent Success w/ Permanent Unlock Code LastErrorText Standard Information
|