file_tag_exists Method

Checks whether a file tag exists.

Syntax

def file_tag_exists(file_name: str, tag_id: int, tag_name: str) -> bool: ...

Remarks

This method checks whether a file tag with the specified TagId or TagName is attached to the file, directory, or alternate stream specified by FileName. If the specified file tag exists, this method returns True; otherwise it returns False.

The value passed for FileName must be a vault-local absolute path.

To check for a raw file tag, pass its Id for TagId and pass empty string for TagName. To check for a typed file tag, pass its name for TagName and pass 0 for TagId. If values are provided for both TagId and TagName, this method raises an exception.

Please refer to the File Tags topic for more information.

Note: This method can only be called when active is True.