GetFileTagAsString Method

Retrieves the value of a String-typed file tag attached to the specified vault item.


public string GetFileTagAsString(string fileName, string tagName);
Public Function GetFileTagAsString(ByVal FileName As String, ByVal TagName As String) As String


This method retrieves the value of a String-typed file tag, identified by TagName, attached to the vault item (file, directory, or alternate stream) specified by FileName. If there isn't a String-typed file tag with the specified TagName attached to the specified vault item, this method throws an exception.

The value passed for FileName must be a vault-local absolute path. The value passed for TagName may be up to 4095 characters in length (not including the null terminator).

Please refer to the File Tags topic for more information.

This method can only retrieve typed file tags created with the SetFileTagAsString method. Typed file tags created with the SetFileTagAsAnsiString method must be retrieved using the GetFileTagAsAnsiString method.

Note: This method can only be called when Active is true.

Copyright (c) 2021 Callback Technologies, Inc. - All rights reserved.
CBFS Vault 2020 .NET Edition - Version 20.0 [Build 7982]