Platforms to show: All Mac Windows Linux Cross-Platform
XMPMetaMBS.AppendArrayItem(schemaNS as string, arrayName as string, arrayOptions as integer, itemValue as string, options as integer=0)
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Appends an item to an array.
Notes:
AppendArrayItem simplifies construction of an array by not requiring that you pre-create an empty array. The array that is assigned is created automatically if it does not yet exist. Each call to AppendArrayItem appends an item to the array. The corresponding parameters have the same use as SetArrayItem. The arrayOptions parameter is used to specify what kind of array. If the array exists, it must have the specified form.
Parameters:
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Appends an item to an array.
Notes:
AppendArrayItem simplifies construction of an array by not requiring that you pre-create an empty array. The array that is assigned is created automatically if it does not yet exist. Each call to AppendArrayItem appends an item to the array. The corresponding parameters have the same use as SetArrayItem. The arrayOptions parameter is used to specify what kind of array. If the array exists, it must have the specified form.
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 null or the empty string. Has the same namespace prefix usage as propPath in GetProperty. |
| arrayOptions | Option flags describing the array form. The only valid bits are those that are part of kXMP_PropArrayFormMask: kXMP_PropValueIsArray (&h200), kXMP_PropArrayIsOrdered (&h400), kXMP_PropArrayIsAlternate (&h800), or kXMP_PropArrayIsAltText (&h1000). |
| 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. |
| itemOptions | Option flags describing the item. |
XMPMetaMBS.AppendProperties(dest as XMPMetaMBS, options as integer=0)
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Append properties from one XMP object to another.
Notes:
Parameters:
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Append properties from one XMP object to another.
Notes:
Parameters:
| self | The source XMP object. |
| dest | The destination XMP object. |
| options | Option flags to control the copying. |
XMPMetaMBS.CatenateArrayItems(schemaNS as string, arrayName as string, separator as string, quotes as string, options as integer) as string
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Create a single edit string from an array of strings.
Notes:
returns the string with the catenated array items.
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Create a single edit string from an array of strings.
Notes:
| xmpObj | The XMP object containing the array to be catenated. |
| schemaNS | The schema namespace URI for the array. Must not be an empty string. |
| arrayName | The name of the array. May be a general path expression, must not be an empty string. Each item in the array must be a simple string value. |
| separator | The string to be used to separate the items in the catenated string. Defaults to "; ", ASCII semicolon and space (U+003B, U+0020). |
| quotes | The characters to be used as quotes around array items that contain a separator. Defaults to '"', ASCII quote (U+0022). |
| options | Option flags to control the catenation. |
class XMPMetaMBS
class, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: The main class for the Adobe XMP SDK.
class, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: The main class for the Adobe XMP SDK.
XMPMetaMBS.Clone as XMPMetaMBS
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Creates a copy of the XMPMeta Object.
Notes:
Deep copy, not just a new reference.
Returns nil on any error.
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Creates a copy of the XMPMeta Object.
Notes:
Deep copy, not just a new reference.
Returns nil on any error.
XMPMetaMBS.ComposeArrayItemPath(schemaNS as string, arrayName as string, itemIndex as integer) as string
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Compose the path expression for an item in an array.
Notes:
Returns the composed path. This will be of the form <tt>ns:arrayName[i]</tt>, where "ns" is the prefix for schemaNS and "i" is the decimal representation of itemIndex. If the value of itemIndex is kXMP_ArrayLastItem, the path is <tt>ns:arrayName[last()]</tt>.
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Compose the path expression for an item in an array.
Notes:
| schemaNS | The 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 be an empty string. |
| 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. |
XMPMetaMBS.ComposeFieldSelector(schemaNS as string, arrayName as string, fieldNS as string, fieldName as string, fieldValue as string) as string
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Compose the path expression to select an alternate item by a field's value.
Notes:
The path syntax allows two forms of "content addressing" that may be used to select an item in an array of alternatives. The form used in ComposeFieldSelector lets you select an item in an array of structs based on the value of one of the fields in the structs. The other form of content addressing is shown in ComposeLangSelector.
For example, consider a simple struct that has two fields, the name of a city and the URI of an FTP site in that city. Use this to create an array of download alternatives. You can show the user a popup built from the values of the city fields. You can then get the corresponding URI as follows:
path=ComposeFieldSelector ( schemaNS, "Downloads", fieldNS, "City", chosenCity)
exists = GetStructField ( schemaNS, path, fieldNS, "URI", uri )
Returns the string with the composed path. This will be of the form <tt>ns:arrayName[fNS:fieldName='fieldValue']</tt>, where "ns" is the prefix for schemaNS and "fNS" is the prefix for fieldNS.
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Compose the path expression to select an alternate item by a field's value.
Notes:
The path syntax allows two forms of "content addressing" that may be used to select an item in an array of alternatives. The form used in ComposeFieldSelector lets you select an item in an array of structs based on the value of one of the fields in the structs. The other form of content addressing is shown in ComposeLangSelector.
For example, consider a simple struct that has two fields, the name of a city and the URI of an FTP site in that city. Use this to create an array of download alternatives. You can show the user a popup built from the values of the city fields. You can then get the corresponding URI as follows:
path=ComposeFieldSelector ( schemaNS, "Downloads", fieldNS, "City", chosenCity)
exists = GetStructField ( schemaNS, path, fieldNS, "URI", uri )
| schemaNS | The 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 be an empty string. |
| fieldNS | The namespace URI for the field used as the selector. Must not be an empty string. |
| fieldName | The name of the field used as the selector. Must be a simple XML name, must not be an empty string. It must be the name of a field that is itself simple. |
| fieldValue | The desired value of the field. |
XMPMetaMBS.ComposeLangSelector(schemaNS as string, arrayName as string, langName as string) as string
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Compose the path expression to select an alternate item by language.
Notes:
The path syntax allows two forms of "content addressing" that may be used to select an item in an array of alternatives. The form used in ComposeLangSelector lets you select an item in an alt-text array based on the value of its <tt>xml:lang</tt> qualifier. The other form of content addressing is shown in ComposeFieldSelector.
ComposeLangSelector does not supplant SetLocalizedText or GetLocalizedText.
They should generally be used, as they provide extra logic to choose the appropriate language and maintain consistency with the 'x-default' value. ComposeLangSelector gives you an path expression that is explicitly and only for the language given in the langName parameter.
Returns the composed path. This will be of the form <tt>ns:arrayName[\@xml:lang='langName']</tt>, where "ns" is the prefix for schemaNS.
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Compose the path expression to select an alternate item by language.
Notes:
The path syntax allows two forms of "content addressing" that may be used to select an item in an array of alternatives. The form used in ComposeLangSelector lets you select an item in an alt-text array based on the value of its <tt>xml:lang</tt> qualifier. The other form of content addressing is shown in ComposeFieldSelector.
ComposeLangSelector does not supplant SetLocalizedText or GetLocalizedText.
They should generally be used, as they provide extra logic to choose the appropriate language and maintain consistency with the 'x-default' value. ComposeLangSelector gives you an path expression that is explicitly and only for the language given in the langName parameter.
| schemaNS | The 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 be an empty string. |
| langName | The RFC 3066 code for the desired language. |
XMPMetaMBS.ComposeQualifierPath(schemaNS as string, structName as string, qualNS as string, qualName as string) as string
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Compose the path expression for a qualifier.
Notes:
schemaNS The namespace URI for the property to which the qualifier is attached. Must not be an empty string.
propName The name of the property to which the qualifier is attached. May be a general path expression, must not be an empty string.
qualNS The namespace URI for the qualifier. May be an empty string if the qualifier is in the XML empty namespace.
qualName The name of the qualifier. Must be a simple XML name, must not be an empty string.
Returns the composed path. This will be of the form <tt>ns:propName/?qNS:qualName</tt>, where "ns" is the prefix for schemaNS and "qNS" is the prefix for qualNS.
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Compose the path expression for a qualifier.
Notes:
schemaNS The namespace URI for the property to which the qualifier is attached. Must not be an empty string.
propName The name of the property to which the qualifier is attached. May be a general path expression, must not be an empty string.
qualNS The namespace URI for the qualifier. May be an empty string if the qualifier is in the XML empty namespace.
qualName The name of the qualifier. Must be a simple XML name, must not be an empty string.
Returns the composed path. This will be of the form <tt>ns:propName/?qNS:qualName</tt>, where "ns" is the prefix for schemaNS and "qNS" is the prefix for qualNS.
XMPMetaMBS.ComposeStructFieldPath(schemaNS as string, structName as string, fieldNS as string, fieldName as string) as string
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Compose the path expression for a field in a struct.
Notes:
Returns the composed path. This will be of the form <tt>ns:structName/fNS:fieldName</tt>, where "ns" is the prefix for schemaNS and "fNS" is the prefix for fieldNS.
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Compose the path expression for a field in a struct.
Notes:
| schemaNS | The namespace URI for the struct. Must not be null or the empty string. |
| structName | The name of the struct. May be a general path expression, must not be an empty string. |
| fieldNS | The namespace URI for the field. Must not be an empty string. |
| fieldName | The name of the field. Must be a simple XML name, must not be an empty string. |
XMPMetaMBS.Constructor
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Default constructor, creates an empty object.
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Default constructor, creates an empty object.
See also:
XMPMetaMBS.Constructor(data as memoryblock, Offset as integer, Size as integer)
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Construct an object and parse one buffer of RDF into it.
Notes: This constructor creates a new TXMPMeta object and populates it with metadata from a buffer containing serialized RDF. This buffer must be a complete RDF parse stream. Pass "" to construct an empty XMPMetaMBS object. The result of an actual parse is identical to creating an empty object then calling XMPMetaMBS.ParseFromBuffer. The RDF must be complete. If you need to parse with multiple buffers, create an empty object and use XMPMetaMBS.ParseFromBuffer.
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Construct an object and parse one buffer of RDF into it.
Notes: This constructor creates a new TXMPMeta object and populates it with metadata from a buffer containing serialized RDF. This buffer must be a complete RDF parse stream. Pass "" to construct an empty XMPMetaMBS object. The result of an actual parse is identical to creating an empty object then calling XMPMetaMBS.ParseFromBuffer. The RDF must be complete. If you need to parse with multiple buffers, create an empty object and use XMPMetaMBS.ParseFromBuffer.
See also:
XMPMetaMBS.Constructor(data as string)
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Construct an object and parse one buffer of RDF into it.
Notes: This constructor creates a new TXMPMeta object and populates it with metadata from a buffer containing serialized RDF. This buffer must be a complete RDF parse stream. Pass "" to construct an empty XMPMetaMBS object. The result of an actual parse is identical to creating an empty object then calling XMPMetaMBS.ParseFromBuffer. The RDF must be complete. If you need to parse with multiple buffers, create an empty object and use XMPMetaMBS.ParseFromBuffer.
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Construct an object and parse one buffer of RDF into it.
Notes: This constructor creates a new TXMPMeta object and populates it with metadata from a buffer containing serialized RDF. This buffer must be a complete RDF parse stream. Pass "" to construct an empty XMPMetaMBS object. The result of an actual parse is identical to creating an empty object then calling XMPMetaMBS.ParseFromBuffer. The RDF must be complete. If you need to parse with multiple buffers, create an empty object and use XMPMetaMBS.ParseFromBuffer.
See also:
XMPMetaMBS.ConvertFromBool(value as boolean) as string
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Convert from Boolean to string.
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Convert from Boolean to string.
XMPMetaMBS.ConvertFromDate(value as XMPDateTimeMBS) as string
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Convert from date/time to string.
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Convert from date/time to string.
XMPMetaMBS.ConvertFromFloat(value as double, format as string) as string
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Convert from floating point to string.
Notes: format: Optional C sprintf format for the conversion. Defaults to "%f".
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Convert from floating point to string.
Notes: format: Optional C sprintf format for the conversion. Defaults to "%f".
XMPMetaMBS.ConvertFromInt(value as integer, format as string) as string
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Convert from integer to string.
Notes: format: Optional C sprintf format for the conversion. Defaults to "%d".
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Convert from integer to string.
Notes: format: Optional C sprintf format for the conversion. Defaults to "%d".
XMPMetaMBS.ConvertFromInt64double(value as double, format as string) as string
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Convert from integer to string.
Notes: format: Optional C sprintf format for the conversion. Defaults to "%d".
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Convert from integer to string.
Notes: format: Optional C sprintf format for the conversion. Defaults to "%d".
XMPMetaMBS.ConvertToBool(value as string) as boolean
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Convert from string to Boolean.
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Convert from string to Boolean.
XMPMetaMBS.ConvertToDate(value as string) as XMPDateTimeMBS
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Convert from string to date/time.
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Convert from string to date/time.
XMPMetaMBS.ConvertToFloat(value as string) as double
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Convert from string to floating point.
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Convert from string to floating point.
XMPMetaMBS.ConvertToInt(value as string) as integer
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Convert from string to integer.
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Convert from string to integer.
XMPMetaMBS.ConvertToInt64double(value as string) as double
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Convert from string to 64 bit integer.
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Convert from string to 64 bit integer.
XMPMetaMBS.CountArrayItems(schemaNS as string, arrayName as string) as integer
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Counts array items of given array.
Notes: Returns 0 on any error.
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Counts array items of given array.
Notes: Returns 0 on any error.
XMPMetaMBS.CurrentDateTime as XMPDateTimeMBS
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Current date and time as a XMPDateTimeMBS object.
Notes: Returns nil on any error.
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Current date and time as a XMPDateTimeMBS object.
Notes: Returns nil on any error.
XMPMetaMBS.DecodeFromBase64(text as string) as string
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Decode from Base64 encoded string to raw data.
Example:
Notes: This is a global method which does not need a valid handle.
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Decode from Base64 encoded string to raw data.
Example:
dim x as XMPMetaMBS
x=new XMPMetaMBS
MsgBox x.DecodeFromBase64("dGVzdA==") // test
XMPMetaMBS.DeleteAlias(aliasNS as string, aliasProp as string)
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Deletes an alias.
Notes:
This deletes only the registration of the alias, it does not delete the actual property.
It deletes any view of the property through the alias name.
aliasNS: The namespace URI for the alias. Must not be null or the empty string.
aliasProp: The name of the alias. Must be a simple name, not nan empty string and not a general path expression. It is not an error to provide a name that has not been registered as an alias.
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Deletes an alias.
Notes:
This deletes only the registration of the alias, it does not delete the actual property.
It deletes any view of the property through the alias name.
aliasNS: The namespace URI for the alias. Must not be null or the empty string.
aliasProp: The name of the alias. Must be a simple name, not nan empty string and not a general path expression. It is not an error to provide a name that has not been registered as an alias.
XMPMetaMBS.DeleteArrayItem(schemaNS as string, arrayName as string, itemIndex as integer)
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: DeleteArrayItem deletes the given XMP subtree rooted at the given array item.
Notes:
It is not an error if the array item does not exist.
Parameters:
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: DeleteArrayItem deletes the given XMP subtree rooted at the given array item.
Notes:
It is not an error if the array item does not exist.
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 "". 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 (-1) always refers to the last existing array item. |
XMPMetaMBS.DeleteNamespace(namespaceURI as string)
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Deletes a namespace from the registry.
Notes:
Not implemented?
Does nothing if the URI is not registered, or if the parameter is null or the empty string.
namespaceURI: The URI for the namespace.
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Deletes a namespace from the registry.
Notes:
Not implemented?
Does nothing if the URI is not registered, or if the parameter is null or the empty string.
namespaceURI: The URI for the namespace.
XMPMetaMBS.DeleteProperty(schemaNS as string, propName as string)
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: DeleteProperty deletes the given XMP subtree rooted at the given property.
Notes:
It is not an error if the property does not exist.
Parameters:
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: DeleteProperty deletes the given XMP subtree rooted at the given property.
Notes:
It is not an error if the property does not exist.
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. |
XMPMetaMBS.DeleteQualifier(schemaNS as string, structName as string, qualNS as string, qualName as string)
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: DeleteQualifier deletes the given XMP subtree rooted at the given qualifier.
Notes:
It is not an error if the qualifier does not exist.
Parameters:
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: DeleteQualifier deletes the given XMP subtree rooted at the given qualifier.
Notes:
It is not an error if the qualifier does not exist.
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 "" Has the same namespace prefix usage as the propName parameter. |
XMPMetaMBS.DeleteStructField(schemaNS as string, structName as string, fieldNS as string, fieldName as string)
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: DeleteStructField deletes the given XMP subtree rooted at the given struct field.
Notes:
It is not an error if the field does not exist.
Parameters:
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: DeleteStructField deletes the given XMP subtree rooted at the given struct field.
Notes:
It is not an error if the field does not exist.
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 "". 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 "". Has the same namespace prefix usage as the structName parameter. |
XMPMetaMBS.DoesArrayItemExist(schemaNS as string, arrayName as string, itemIndex as integer) as boolean
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: DoesArrayItemExist tells if the array item exists.
Notes:
Returns true if the array item exists.
Parameters:
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: DoesArrayItemExist tells if the array item exists.
Notes:
Returns true if the array item exists.
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 "". 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 (-1) always refers to the last existing array item. |
XMPMetaMBS.DoesPropertyExist(schemaNS as string, propName as string) as boolean
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: DoesPropertyExist tells if the property exists.
Notes:
Returns true if the property exists.
Parameters:
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: DoesPropertyExist tells if the property exists.
Notes:
Returns true if the property exists.
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. |
XMPMetaMBS.DoesQualifierExist(schemaNS as string, structName as string, qualNS as string, qualName as string) as boolean
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: DoesQualifierExist tells if the qualifier exists.
Notes:
Returns true if the qualifier exists.
Parameters:
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: DoesQualifierExist tells if the qualifier exists.
Notes:
Returns true if the qualifier exists.
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 "". Has the same namespace prefix usage as the propName parameter. |
XMPMetaMBS.DoesStructFieldExist(schemaNS as string, structName as string, fieldNS as string, fieldName as string) as boolean
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: DoesStructFieldExist tells if the struct field exists.
Notes:
Returns true if the field exists.
Parameters:
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: DoesStructFieldExist tells if the struct field exists.
Notes:
Returns true if the field exists.
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 "". 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 "". Has the same namespace prefix usage as the structName parameter. |
XMPMetaMBS.DumpAliases(output as XMPTextOutputMBS) as integer
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: DumpAliases dumps the list of registered aliases and corresponding actuals.
Notes:
Returns status code. (0=success and -1=error)
This is a global method which does not need a valid handle.
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: DumpAliases dumps the list of registered aliases and corresponding actuals.
Notes:
Returns status code. (0=success and -1=error)
This is a global method which does not need a valid handle.
XMPMetaMBS.DumpNamespaces(output as XMPTextOutputMBS) as integer
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: DumpNamespaces dumps the list of registered namespace URIs and prefixes.
Notes:
This is a global method which does not need a valid handle.
Returns status code. (0=success and -1=error)
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: DumpNamespaces dumps the list of registered namespace URIs and prefixes.
Notes:
This is a global method which does not need a valid handle.
Returns status code. (0=success and -1=error)
XMPMetaMBS.DumpObject(output as XMPTextOutputMBS) as integer
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: DumpObject dumps the content of an XMP object.
Notes: Returns status code. (0=success and -1=error)
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: DumpObject dumps the content of an XMP object.
Notes: Returns status code. (0=success and -1=error)
XMPMetaMBS.DuplicateSubtree(dest as XMPMetaMBS, sourceNS as string, sourceRoot as string, destNS as string="", destRoot as string="", options as integer=0)
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Replicate a subtree from one XMP object into another, possibly at a different location.
Notes:
Parameters:
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Replicate a subtree from one XMP object into another, possibly at a different location.
Notes:
Parameters:
| self | The source XMP object. |
| dest | The destination XMP object. |
| sourceNS | The schema namespace URI for the source subtree. |
| sourceRoot | The root location for the source subtree. May be a general path expression, must not be null or the empty string. |
| destNS | The schema namespace URI for the destination. Defaults to the source namespace. |
| destRoot | The root location for the destination. May be a general path expression. Defaults to the source location. |
| options | Option flags to control the separation. |
XMPMetaMBS.EncodeToBase64(text as string) as string
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Convert from raw data to Base64 encoded string.
Example:
Notes: This is a global method which does not need a valid handle.
shared method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Convert from raw data to Base64 encoded string.
Example:
dim x as XMPMetaMBS
x=new XMPMetaMBS
MsgBox x.EncodeToBase64("test") // dGVzdA==
XMPMetaMBS.Erase
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Restores the object to a "just constructed" state.
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 9.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: Restores the object to a "just constructed" state.
XMPMetaMBS.GetArrayItem(schemaNS as string, arrayName as string, itemIndex as integer, byref itemValue as string, byref options as integer) as boolean
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: GetArrayItem provides access to items within an array.
Notes:
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.
Returns true if the array item exists.
Parameters:
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: GetArrayItem provides access to items within an array.
Notes:
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.
Returns true if the array item exists.
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 "". 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 (-1) always refers to the last existing array item. |
| itemValue | A string that is assigned the value of the array item, if the array item has a value. Arrays and non-leaf levels of structs do not have values. |
| options | An integer variable that is assigned option flags describing the array item. |
XMPMetaMBS.GetLocalizedText(schemaNS as string, altTextName as string, genericLang as string, specificLang as string, byref actualLang as string, byref itemValue as string, byref options as integer) as boolean
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: GetLocalizedText returns information about a selected item in an alt-text array.
Notes:
The array item is selected according to the rules given above.
Returns true if an appropriate array item exists.
Parameters:
method, XMP, MBS REALbasic XMP Plugin (XMP), class XMPMetaMBS, Console safe, Plugin version: 6.4, Mac OS X: Works, Windows: Works, Linux x86: Works, Feedback.
Function: GetLocalizedText returns information about a selected item in an alt-text array.
Notes:
The array item is selected according to the rules given above.
Returns true if an appropriate array item exists.
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 "". Has the same namespace prefix usage as propName in GetProperty. |
| genericLang | The name of the generic language as an RFC 3066 primary subtag. May be "" if no generic language is wanted. |
| specificLang | The name of the specific language as an RFC 3066 tag. Must not be null or the empty string. |
| actualLang | A string that is assigned the language of the selected array item, if an appropriate array item is found. |
| itemValue | A string that is assigned the value of the array item, if an appropriate array item is found. |
| options | An integer variable that is assigned option flags describing the array item. |
The items on this page are in the following plugins: MBS REALbasic XMP Plugin.