Xmp DataFlex Reference Documentation

Xmp

Current Version: 9.5.0.73

Chilkat XMP is a software component (SDK, toolkit, library, etc) for accessing, manipulating, and adding XMP metadata to JPEG and TIFF files.

Object Creation

// (Dataflex programs use the 32-bit Chilkat ActiveX)
Handle hoXmp
Get Create(RefClass(cComChilkatXmp)) to hoXmp

Properties

DebugLogFilePath
Function ComDebugLogFilePath Returns String
Procedure Set ComDebugLogFilePath String value

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.

top
LastBinaryResult
Function ComLastBinaryResult Returns Variant
Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to True. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

top
LastErrorHtml
Function ComLastErrorHtml Returns String

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.

top
LastErrorText
Function ComLastErrorText Returns String

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.

top
LastErrorXml
Function ComLastErrorXml Returns String

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.

top
LastMethodSuccess
Function ComLastMethodSuccess Returns Boolean
Procedure Set ComLastMethodSuccess Boolean value
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of True indicates success, a value of False indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = True and failure = False.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to True. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
LastStringResult
Function ComLastStringResult Returns String
Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to True. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

top
LastStringResultLen
Function ComLastStringResultLen Returns Integer
Introduced in version 9.5.0.53

The length, in characters, of the string contained in the LastStringResult property.

top
NumEmbedded
Function ComNumEmbedded Returns Integer

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

top
StructInnerDescrip
Function ComStructInnerDescrip Returns Boolean
Procedure Set ComStructInnerDescrip Boolean value

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

top
VerboseLogging
Function ComVerboseLogging Returns Boolean
Procedure Set ComVerboseLogging Boolean value

If set to True, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is False. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
Function ComVersion Returns String

Version of the component/library, such as "9.5.0.63"

top

Methods

AddArray
Function ComAddArray cComChilkatXml xml String arrType String propName cComCkStringArray values Returns 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".

More Information and Examples
top
AddNsMapping
Procedure ComAddNsMapping String ns String 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.

top
AddSimpleDate
Function ComAddSimpleDate cComChilkatXml iXml String propName DateTime propVal Returns Boolean
This method is deprecated. It will be removed in a future version.

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

top
AddSimpleInt
Function ComAddSimpleInt cComChilkatXml iXml String propName Integer propVal Returns 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".

top
AddSimpleStr
Function ComAddSimpleStr cComChilkatXml iXml String propName String propVal Returns 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".

top
AddStructProp
Function ComAddStructProp cComChilkatXml iChilkatXml String structName String propName String propValue Returns 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".

top
Append
Function ComAppend cComChilkatXml iXml Returns 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.

top
DateToString
Function ComDateToString DateTime d Returns String
This method is deprecated. It will be removed in a future version.

Converts a date to a string representation. This method is added for convenience (just in case date-to-string conversions are required).

Returns null on failure

top
GetArray
Function ComGetArray cComChilkatXml iXml String propName Returns cComCkStringArray

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

Returns null on failure

top
GetEmbedded
Function ComGetEmbedded Integer index Returns cComChilkatXml

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

Returns null on failure

top
GetProperty
Function ComGetProperty cComChilkatXml iXml String propName Returns cComChilkatXml

To be documented soon...

Returns null on failure

top
GetSimpleDate
Function ComGetSimpleDate cComChilkatXml iXml String propName Returns DateTime
This method is deprecated. It will be removed in a future version.

Finds and returns an XMP date property. The property name should be prefixed with the namespace, such as "xap:ModifyDate".

top
GetSimpleInt
Function ComGetSimpleInt cComChilkatXml iXml String propName Returns Integer

Finds and returns an XMP integer property. The property name should be prefixed with the namespace, such as "tiff:ResolutionUnit".

top
GetSimpleStr
Function ComGetSimpleStr cComChilkatXml iXml String propName Returns String

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

More Information and Examples
top
GetStructPropNames
Function ComGetStructPropNames cComChilkatXml iXml String structName Returns cComCkStringArray

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

top
GetStructValue
Function ComGetStructValue cComChilkatXml iXml String structName String propName Returns String

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

More Information and Examples
top
LoadAppFile
Function ComLoadAppFile String filename Returns Boolean

Loads a TIFF or JPG file into the XMP object.

top
LoadFromBuffer
Function ComLoadFromBuffer Variant fileData String ext Returns Boolean

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

top
NewXmp
Function ComNewXmp Returns cComChilkatXml

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

Returns null on failure

More Information and Examples
top
RemoveAllEmbedded
Function ComRemoveAllEmbedded Returns 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.

top
RemoveArray
Function ComRemoveArray cComChilkatXml iXml String propName Returns Boolean

Removes an XMP array property from the XMP document.

top
RemoveEmbedded
Function ComRemoveEmbedded Integer index Returns 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.

top
RemoveNsMapping
Procedure ComRemoveNsMapping String ns

Removes a namespace-to-URI mapping.

top
RemoveSimple
Function ComRemoveSimple cComChilkatXml iXml String propName Returns Boolean

Removes a simple XMP property from the XMP document.

top
RemoveStruct
Function ComRemoveStruct cComChilkatXml iXml String structName Returns Boolean

Removes an XMP structure property from the XMP document.

top
RemoveStructProp
Function ComRemoveStructProp cComChilkatXml iXml String structName String propName Returns Boolean

Removes a single member from an XMP structured property.

top
SaveAppFile
Function ComSaveAppFile String filename Returns 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.

top
SaveToBuffer
Function ComSaveToBuffer Returns Variant

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

Returns null on failure

top
StringToDate
Function ComStringToDate String str Returns DateTime
This method is deprecated. It will be removed in a future version.

Converts a string to a date value. This method is added for convenience (just in case string-to-date conversions are required).

top
UnlockComponent
Function ComUnlockComponent String unlockCode Returns Boolean

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 purchased unlock code is required to use the component beyond 30 days.

top