XMPMetaMBS.ParseFromBuffer(buffer as string, options as Integer=0)

The buffers may be any length. The buffer boundaries need not respect XML tokens or even Unicode characters.

Parameters:

buffer	Input data buffer. Termination of an input loop is convenient by passing kXMP_ParseMoreBuffers (2) for all real input, then having a final call with a zero length and kXMP_NoOptions.
options	Options controlling the parsing.

The available options are:

kXMP_ParseMoreBuffers	= 2	This is not the last buffer of input, more calls follow.
kXMP_RequireXMPMeta	= 1	The x:xmpmeta XML element is required around rdf:RDF.
kXMP_StrictAliasing	= 4	Do not reconcile alias differences, throw an exception.

Note: The kXMP_StrictAliasing option is not yet implemented.

Some examples using this method:

• /XMP/XMP Core Coverage

XMPMetaMBS.RemoveProperties(schemaNS as string="", propName as string="", options as Integer=0)

RemoveProperties was created to support the File Info dialog's Delete button, and has been been generalized somewhat from those specific needs. It operates in one of three main modes depending on the schemaNS and propName parameters:
Non-empty schemaNS and propName - The named property is removed if it is an external property, or if the kXMPUI_DoAllProperties option is passed. It does not matter whether the named property is an actual property or an alias.
Non-empty schemaNS and empty propName - The all external properties in the named schema are removed. Internal properties are also removed if the kXMPUI_DoAllProperties option is passed. In addition, aliases from the named schema will be removed if the kXMPUI_IncludeAliases option is passed.
Empty schemaNS and empty propName - All external properties in all schema are removed. Internal properties are also removed if the kXMPUI_DoAllProperties option is passed. Aliases are implicitly handled because the associated actuals are.
It is an error to pass and empty schemaNS and non-empty propName.

xmpObj	The XMP object containing the properties to be removed.
schemaNS	Optional schema namespace URI for the properties to be removed.
propName	Optional path expression for the property to be removed.
options	Option flags to control the deletion. The defined flags are: kXMPUI_DoAllProperties - Do internal properties in addition to external properties. kXMPUI_IncludeAliases - Include aliases in the "named schema" case above.

XMPMetaMBS.SeparateArrayItems(schemaNS as string, arrayName as string, options as Integer, catedStr as string)

Parameters:

xmpObj	The XMP object containing the array to be updated.
schemaNS	The schema namespace URI for the array. Must not be null or the empty string.
arrayName	The name of the array. May be a general path expression, must not an empty string. Each item in the array must be a simple string value.
options	Option flags to control the separation.
catedStr	The string to be separated into the array items.

Some examples using this method:

• /XMP/XMP Core Coverage

XMPMetaMBS.SerializeToBuffer(options as Integer, padding as Integer, newline as string, indent as string="", baseIndent as Integer=0) as string

Returns the serialized RDF.

Parameters:

options	Option flags to control the serialization.
padding	The amount of padding to be added if a writeable XML packet is created. If zero is passed (the default) an appropriate amount of padding is computed.
newline	The string to be used as a line terminator. If empty it defaults to linefeed, U+000A, the standard XML newline.
indent	The string to be used for each level of indentation in the serialized RDF. If empty it defaults to two ASCII spaces, U+0020.
baseIndent	The number of levels of indentation to be used for the outermost XML element in the serialized RDF. This is convenient when embedding the RDF in other text.

The available option flags are:

kXMP_OmitPacketWrapper	= &h10	Do not include an XML packet wrapper.
kXMP_ReadOnlyPacket	= &h20	Create a read-only XML packet wapper.
kXMP_UseCompactFormat	= &h40	Use a highly compact RDF syntax and layout.
kXMP_WriteAliasComments	= &h400	Include XML comments for aliases.
kXMP_IncludeThumbnailPad	= &h100	Include typical space for a JPEG thumbnail in the padding if no xmp:Thumbnails property is present.
kXMP_ExactPacketLength	= &h200	The padding parameter provides the overall packet length. The actual amount of padding is computed. An exception is thrown if the packet exceeds this length with no padding.

The specified options must be logically consistent, an exception is thrown if not. You cannot specify both kXMP_OmitPacketWrapper along with kXMP_ReadOnlyPacket, kXMP_IncludeThumbnailPad, or kXMP_ExactPacketLength.
In addition, one of the following encoding options may be included:

kXMP_EncodeUTF8	= 0	Encode as UTF-8, the default.
kXMP_EncodeUTF16Big	= 2	Encode as big-endian UTF-16.
kXMP_EncodeUTF16Little	= 3	Encode as little-endian UTF-16.
kXMP_EncodeUTF32Big	= 4	Encode as big-endian UTF-32.
kXMP_EncodeUTF32Little	= 5	Encode as little-endian UTF-32.

See also:

• SerializeToBuffer(options as Integer=0, padding as Integer=0) as string

Some examples using this method:

• /DynaPDF/Create PDF and modify XMP
• /XMP/XMP Core Coverage

XMPMetaMBS.SerializeToBuffer(options as Integer=0, padding as Integer=0) as string

dim x as new XMPMetaMBS
dim registeredPrefix as string

call x.RegisterNamespace ("xwnv", "xwnv", registeredPrefix)

x.SetProperty "xwnv","MZSTID","test"

MsgBox x.SerializeToBuffer

Same as other SerializeToBuffer method, but with newline="", indent=0 and baseIndent=0.

See also:

• SerializeToBuffer(options as Integer, padding as Integer, newline as string, indent as string="", baseIndent as Integer=0) as string

XMPMetaMBS.SetArrayItem(schemaNS as string, arrayName as string, itemIndex as Integer, itemValue as string, options as Integer=0)

The index is passed as an integer, you need not worry about the path string syntax for array items, convert a loop index to a string, etc. The array passed to SetArrayItem must already exist. See also AppendArrayItem.

In normal usage the selected array item is modified. A new item is automatically appended if the index is the array size plus 1. A new item may be inserted before or after any item by using one of the following option flags:

kXMP_InsertBeforeItem	= &h4000	Insert a new array item before the selected one.
kXMP_InsertAfterItem	= &h8000	Insert a new array item after the selected one.

Parameters:

schemaNS	The namespace URI for the array. Has the same usage as in GetProperty.
arrayName	The name of the array. May be a general path expression, must not be an empty string. Has the same namespace prefix usage as propName in GetProperty.
itemIndex	The index of the desired item. Arrays in XMP are indexed from 1. The constant kXMP_ArrayLastItem always refers to the last existing array item.
itemValue	An UTF-8 string that is the value of the array item, if the array item has a value. Has the same usage as propValue in GetProperty.
options	Option flags describing the item. See the earlier description.

Some examples using this method:

• /XMP/XMP Core Coverage

XMPMetaMBS.SetLocalizedText(schemaNS as string, altTextName as string, genericLang as string, specificLang as string, itemValue as string, options as Integer=0)

Creates an appropriate array item if necessary, and handles special cases for the x-default item.

If the selected item is from a match with the specific language, the value of that item is modified. If the existing value of that item matches the existing value of the x-default item, the x-default item is also modified. If the array only has 1 existing item (which is not x-default), an x-default item is added with the given value.
If the selected item is from a match with the generic language and there are no other generic matches, the value of that item is modified. If the existing value of that item matches the existing value of the x-default item, the x-default item is also modified. If the array only has 1 existing item (which is not x-default), an x-default item is added with the given value.
If the selected item is from a partial match with the generic language and there are other partial matches, a new item is created for the specific language. The x-default item is not modified.
If the selected item is from the last 2 rules then a new item is created for the specific language. If the array only had an x-default item, the x-default item is also modified. If the array was empty, items are created for the specific language and x-default.

Parameters:

schemaNS	The namespace URI for the alt-text array. Has the same usage as in GetProperty.
altTextName	The name of the alt-text array. May be a general path expression, must not be an empty string. Has the same namespace prefix usage as propName in GetProperty.
genericLang	The name of the generic language as an RFC 3066 primary subtag.
specificLang	The name of the specific language as an RFC 3066 tag. Must not be an empty string.
itemValue	An UTF-8 string that is the new value for the appropriate array item.
options	Option flags, none are defined at present.

Some examples using this method:

• /XMP/Create EXIF
• /XMP/XMP Core Coverage

XMPMetaMBS.SetProperty(schemaNS as string, propName as string, propValue as string, options as Integer=0)

Parameters:

schemaNS	The namespace URI for the property. Has the same usage as in GetProperty.
propName	The name of the property. Has the same usage as in GetProperty.
propValue	An UTF-8 string that is the value of the property, if the property has a value. Arrays and non-leaf levels of structs do not have values.
options	Option flags describing the property.

XMPMetaMBS.SetPropertyBoolean(schemaNS as string, propName as string, propValue as boolean)

Parameters:

schemaNS	The namespace URI for the property. Has the same usage as in GetProperty.
propName	The name of the property. Has the same usage as in GetProperty.
propValue	The bool value to be assigned to the property.
options	An integer variable that is assigned option flags describing the property.

See also:

• SetPropertyBoolean(schemaNS as string, propName as string, propValue as boolean, options as Integer)

Some examples using this method:

• /XMP/XMP Core Coverage

XMPMetaMBS.SetPropertyBoolean(schemaNS as string, propName as string, propValue as boolean, options as Integer)

Parameters:

schemaNS	The namespace URI for the property. Has the same usage as in GetProperty.
propName	The name of the property. Has the same usage as in GetProperty.
propValue	The bool value to be assigned to the property.
options	An integer variable that is assigned option flags describing the property.

See also:

• SetPropertyBoolean(schemaNS as string, propName as string, propValue as boolean)

XMPMetaMBS.SetPropertyDate(schemaNS as string, propName as string, propValue as XMPDateTimeMBS, options as Integer=0)

Parameters:

schemaNS	The namespace URI for the property. Has the same usage as in GetProperty.
propName	The name of the property. Has the same usage as in GetProperty.
propValue	The XMPDateTimeMBS object to be assigned to the property.
options	Option flags describing the property.

Some examples using this method:

• /DynaPDF/Create PDF and modify XMP
• /XMP/XMP Core Coverage

XMPMetaMBS.SetPropertyFloat(schemaNS as string, propName as string, propValue as Double)

Parameters:

schemaNS	The namespace URI for the property. Has the same usage as in GetProperty.
propName	The name of the property. Has the same usage as in GetProperty.
propValue	The double float value to be assigned to the property.
options	Option flags describing the property.

See also:

• SetPropertyFloat(schemaNS as string, propName as string, propValue as Double, options as Integer)

Some examples using this method:

• /XMP/XMP Core Coverage

XMPMetaMBS.SetPropertyFloat(schemaNS as string, propName as string, propValue as Double, options as Integer)

Parameters:

schemaNS	The namespace URI for the property. Has the same usage as in GetProperty.
propName	The name of the property. Has the same usage as in GetProperty.
propValue	The double float value to be assigned to the property.
options	Option flags describing the property.

See also:

• SetPropertyFloat(schemaNS as string, propName as string, propValue as Double)

XMPMetaMBS.SetPropertyInt64Double(schemaNS as string, propName as string, propValue as Double, options as Integer=0)

Parameters:

schemaNS	The namespace URI for the property. Has the same usage as in GetProperty.
propName	The name of the property. Has the same usage as in GetProperty.
propValue	The double value to be assigned to the property.
options	Option flags describing the property.

XMPMetaMBS.SetPropertyInteger(schemaNS as string, propName as string, propValue as Integer)

Parameters:

schemaNS	The namespace URI for the property. Has the same usage as in GetProperty.
propName	The name of the property. Has the same usage as in GetProperty.
propValue	The long integer value to be assigned to the property.
options	Option flags describing the property.

See also:

• SetPropertyInteger(schemaNS as string, propName as string, propValue as Integer, options as Integer)

Some examples using this method:

• /DynaPDF/Create PDF and modify XMP
• /XMP/XMP Core Coverage

XMPMetaMBS.SetPropertyInteger(schemaNS as string, propName as string, propValue as Integer, options as Integer)

Parameters:

schemaNS	The namespace URI for the property. Has the same usage as in GetProperty.
propName	The name of the property. Has the same usage as in GetProperty.
propValue	The long integer value to be assigned to the property.
options	Option flags describing the property.

See also:

• SetPropertyInteger(schemaNS as string, propName as string, propValue as Integer)

XMPMetaMBS.SetPropertyInteger64(schemaNS as string, propName as string, propValue as Int64, options as Integer=0)

Sets a property with a binary value, creating it if necessary.

schemaNS: The namespace URI; see GetProperty().
propName: The name of the property. Can be a general path expression, must not be "" or the empty string; see GetProperty() for namespace prefix usage.
propValue: The new binary value.
options: Option flags describing the property; a logical OR of allowed bit-flag constants; see kPropValueIsStruct and following. Must match the type of a property that already exists.

XMPMetaMBS.SetQualifier(schemaNS as string, propName as string, qualNS as string, qualName as string, qualValue as string, options as Integer=0)

The namespace for the qualifier is passed as a URI, you need not worry about the path string syntax. In many regards qualifiers are like struct fields. See the introductory discussion of qualified properties for more information.

The names of qualifiers should be XML qualified names, that is within an XML namespace. The path syntax for a qualified name uses the namespace prefix, which is unreliable because the prefix is never guaranteed. The URI is the formal name, the prefix is just a local shorthand in a given sequence of XML text.

Parameters:

schemaNS	The namespace URI for the struct. Has the same usage as in GetProperty.
propName	The name of the property to which the qualifier is attached. Has the same usage as in GetProperty.
qualNS	The namespace URI for the qualifier. Has the same URI and prefix usage as the schemaNS parameter.
qualName	The name of the qualifier. Must be a single XML name, must not be an empty string. Has the same namespace prefix usage as the propName parameter.
qualValue	An UTF-8 string that is the value of the qualifier, if the qualifier has a value. Has the same usage as propValue in GetProperty.
options	Option flags describing the qualifier.

Some examples using this method:

• /XMP/XMP Core Coverage

XMPMetaMBS.SetStructField(schemaNS as string, structName as string, fieldNS as string, fieldName as string, fieldValue as string, options as Integer=0)

The namespace for the field is passed as a URI, you need not worry about the path string syntax.

The names of fields should be XML qualified names, that is within an XML namespace. The path syntax for a qualified name uses the namespace prefix, which is unreliable because the prefix is never guaranteed. The URI is the formal name, the prefix is just a local shorthand in a given sequence of XML text.

Parameters:

schemaNS	The namespace URI for the struct. Has the same usage as in GetProperty.
structName	The name of the struct. May be a general path expression, must not be an empty string. Has the same namespace prefix usage as propName in GetProperty.
fieldNS	The namespace URI for the field. Has the same URI and prefix usage as the schemaNS parameter.
fieldName	The name of the field. Must be a single XML name, must not be null or the empty string. Has the same namespace prefix usage as the structName parameter.
fieldValue	An UTF-8 string that is the value of the field, if the field has a value. Has the same usage as propValue in GetProperty.
options	Option flags describing the field.

Some examples using this method:

• /XMP/XMP Core Coverage

XMPMetaMBS.Sort

Use this function to sort the data model of an XMP object into a canonical order. This can be convenient when comparing data models, (e.g. by text comparison of DumpObject output).

At the top level the namespaces are sorted by their prefixes. Within a namespace, the top level properties are sorted by name. Within a struct, the fields are sorted by their qualified name, i.e. their XML prefix:local form. Unordered arrays of simple items are sorted by value. Language Alternative arrays are sorted by the xml:lang qualifiers, with the "x-default" item placed first.