XMPIteratorMBS.Constructor

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	XMP	MBS XMP Plugin	6.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Empty constructor which does nothing.

See also:

• Constructor(meta as XMPMetaMBS, options as Integer=0)
• Constructor(meta as XMPMetaMBS, schemaNS as string, options as Integer=0)
• Constructor(meta as XMPMetaMBS, schemaNS as string, propName as string, options as Integer=0)
• Constructor(schemaNS as string, propName as string, options as Integer)

XMPIteratorMBS.Constructor(meta as XMPMetaMBS, options as Integer=0)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	XMP	MBS XMP Plugin	6.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Construct an iterator for the global tables of the XMP toolkit.

options: Option flags to control the iteration.

The available option flags are:

kXMP_IterJustChildren	= &h100	Just visit the immediate children of the root, default is subtree.
kXMP_IterJustLeafNodes	= &h200	Just visit the leaf nodes, default visits all nodes.
kXMP_IterJustLeafName	= &h400	Return just the leaf part of the path, default is the full path.
kXMP_IterOmitQualifiers	= &h1000	Omit all qualifiers.

Note: Not yet implemented in the XMP SDK.

See also:

• Constructor
• Constructor(meta as XMPMetaMBS, schemaNS as string, options as Integer=0)
• Constructor(meta as XMPMetaMBS, schemaNS as string, propName as string, options as Integer=0)
• Constructor(schemaNS as string, propName as string, options as Integer)

XMPIteratorMBS.Constructor(meta as XMPMetaMBS, schemaNS as string, options as Integer=0)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	XMP	MBS XMP Plugin	6.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Construct an iterator for the global tables of the XMP toolkit.

schemaNS: Optional schema namespace URI to restrict the iteration. Omitted (visit all schema) by passing "".
options: Option flags to control the iteration.

The available option flags are:

kXMP_IterJustChildren	= &h100	Just visit the immediate children of the root, default is subtree.
kXMP_IterJustLeafNodes	= &h200	Just visit the leaf nodes, default visits all nodes.
kXMP_IterJustLeafName	= &h400	Return just the leaf part of the path, default is the full path.
kXMP_IterOmitQualifiers	= &h1000	Omit all qualifiers.

Note: Not yet implemented in the XMP SDK.

See also:

• Constructor
• Constructor(meta as XMPMetaMBS, options as Integer=0)
• Constructor(meta as XMPMetaMBS, schemaNS as string, propName as string, options as Integer=0)
• Constructor(schemaNS as string, propName as string, options as Integer)

XMPIteratorMBS.Constructor(meta as XMPMetaMBS, schemaNS as string, propName as string, options as Integer=0)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	XMP	MBS XMP Plugin	6.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Construct an iterator for the global tables of the XMP toolkit.

schemaNS: Optional schema namespace URI to restrict the iteration. Omitted (visit all schema) by passing "".
propName: Optional property name to restrict the iteration. May be an arbitrary path expression. Omitted (visit all properties) by passing "". If not empty a schema URI must also be provided.
options: Option flags to control the iteration.

The available option flags are:

kXMP_IterJustChildren	= &h100	Just visit the immediate children of the root, default is subtree.
kXMP_IterJustLeafNodes	= &h200	Just visit the leaf nodes, default visits all nodes.
kXMP_IterJustLeafName	= &h400	Return just the leaf part of the path, default is the full path.
kXMP_IterOmitQualifiers	= &h1000	Omit all qualifiers.

Note: Not yet implemented in the XMP SDK.

See also:

• Constructor
• Constructor(meta as XMPMetaMBS, options as Integer=0)
• Constructor(meta as XMPMetaMBS, schemaNS as string, options as Integer=0)
• Constructor(schemaNS as string, propName as string, options as Integer)

XMPIteratorMBS.Constructor(schemaNS as string, propName as string, options as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	XMP	MBS XMP Plugin	6.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Construct an iterator for the properties within an XMP object.

On success handle is not 0.

schemaNS: Optional schema namespace URI to restrict the iteration. Omitted (visit all schema) by passing "".
propName: Optional property name to restrict the iteration. May be an arbitrary path expression. Omitted (visit all properties) by passing "". If not empty a schema URI must also be provided.
options: Option flags to control the iteration.

The available option flags are:

kXMP_IterJustChildren	= &h100	Just visit the immediate children of the root, default is subtree.
kXMP_IterJustLeafNodes	= &h200	Just visit the leaf nodes, default visits all nodes.
kXMP_IterJustLeafName	= &h400	Return just the leaf part of the path, default is the full path.
kXMP_IterOmitQualifiers	= &h1000	Omit all qualifiers.

See also:

• Constructor
• Constructor(meta as XMPMetaMBS, options as Integer=0)
• Constructor(meta as XMPMetaMBS, schemaNS as string, options as Integer=0)
• Constructor(meta as XMPMetaMBS, schemaNS as string, propName as string, options as Integer=0)

XMPIteratorMBS.NextItem() as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	XMP	MBS XMP Plugin	6.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Visit the next node in the iteration.

See also:

• NextItem(byref schemaNS as string) as boolean
• NextItem(byref schemaNS as string, byref propPath as string) as boolean
• NextItem(byref schemaNS as string, byref propPath as string, byref propValue as string) as boolean
• NextItem(byref schemaNS as string, byref propPath as string, byref propValue as string, byref options as Integer) as boolean

XMPIteratorMBS.NextItem(byref schemaNS as string) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	XMP	MBS XMP Plugin	6.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Visit the next node in the iteration.

Parameters:

schemaNS	A string that is assigned the schema namespace URI of the current property.
propPath	A string that is assigned the XPath name of the current property.
propValue	A string that is assigned the value of the current property.
options	An integer that is assigned the flags describing the current property.

See also:

• NextItem() as boolean
• NextItem(byref schemaNS as string, byref propPath as string) as boolean
• NextItem(byref schemaNS as string, byref propPath as string, byref propValue as string) as boolean
• NextItem(byref schemaNS as string, byref propPath as string, byref propValue as string, byref options as Integer) as boolean

XMPIteratorMBS.NextItem(byref schemaNS as string, byref propPath as string) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	XMP	MBS XMP Plugin	6.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Visit the next node in the iteration.

Parameters:

schemaNS	A string that is assigned the schema namespace URI of the current property.
propPath	A string that is assigned the XPath name of the current property.

See also:

• NextItem() as boolean
• NextItem(byref schemaNS as string) as boolean
• NextItem(byref schemaNS as string, byref propPath as string, byref propValue as string) as boolean
• NextItem(byref schemaNS as string, byref propPath as string, byref propValue as string, byref options as Integer) as boolean

XMPIteratorMBS.NextItem(byref schemaNS as string, byref propPath as string, byref propValue as string) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	XMP	MBS XMP Plugin	6.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Visit the next node in the iteration.

Parameters:

schemaNS	A string that is assigned the schema namespace URI of the current property.
propPath	A string that is assigned the XPath name of the current property.
propValue	A string that is assigned the value of the current property.

See also:

• NextItem() as boolean
• NextItem(byref schemaNS as string) as boolean
• NextItem(byref schemaNS as string, byref propPath as string) as boolean
• NextItem(byref schemaNS as string, byref propPath as string, byref propValue as string, byref options as Integer) as boolean

XMPIteratorMBS.NextItem(byref schemaNS as string, byref propPath as string, byref propValue as string, byref options as Integer) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	XMP	MBS XMP Plugin	6.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Visit the next node in the iteration.

Parameters:

schemaNS	A string that is assigned the schema namespace URI of the current property.
propPath	A string that is assigned the XPath name of the current property.
propValue	A string that is assigned the value of the current property.
options	An integer that is assigned the flags describing the current property.

See also:

• NextItem() as boolean
• NextItem(byref schemaNS as string) as boolean
• NextItem(byref schemaNS as string, byref propPath as string) as boolean
• NextItem(byref schemaNS as string, byref propPath as string, byref propValue as string) as boolean

XMPIteratorMBS.Skip(options as Integer)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	XMP	MBS XMP Plugin	6.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Skip some portion of the remaining iterations.

The available option flags are:

kXMP_IterSkipSubtree	= 1	Skip the subtree below the current node.
kXMP_IterSkipSiblings	= 2	Skip the subtree below and remaining siblings of the current node.