metadata_mod_op Property
The modification operation to perform on the metadata item.
Syntax
def get_metadata_mod_op(metadata_index: int) -> int: ... def set_metadata_mod_op(metadata_index: int, value: int) -> None: ...
Default Value
0
Remarks
The modification operation to perform on the metadata item.
This property specifies which modification operation should be performed for the metadata item when update_metadata is called. Possible values are:
| 0 (opNone - default) | No-Op (the class skips the metadata item). |
| 1 (opAdd) | A new metadata item will be added. If one already exists with the specified metadata_name, its value will be overwritten. |
| 2 (opReplace) | The metadata item with the given metadata_name (which must already exist) will have its value overwritten. |
| 3 (opCopyFrom) | A new metadata item will be added, its value copied from the item specified by metadata_source_name (which must already exist). |
| 4 (opMoveFrom) | A new metadata item will be added, its value moved from the item specified by metadata_source_name (which must already exist). The source item will then be removed. |
| 5 (opRemove) | The metadata item with the given metadata_name (which must already exist) will be removed. |
| 6 (opTest) | Will verify that the metadata item with the given metadata_name (which must already exist) has the specified metadata_value. |
Refer to update_metadata for more information.
The metadata_index parameter specifies the index of the item in the array. The size of the array is controlled by the metadata_count property.