SolFSStorage.GetFileTagInfo method


Pascal    Plain C    C++ (DLL/Lib)    C++ (VCL)    C++ (.NET)    C#    VB.NET    Java 

SolFSStorage     See also    


Returns file/stream tag (custom metadata).


    function GetFileTagInfo( const FileName: TSolFSString; TagID: word; var TagExists: Boolean) : LongWord;

[Plain C]
    long _stdcall StorageGetFileTagInfo( unsigned long Storage, const wchar_t* FileName, unsigned short TagID, Bool* TagExists, unsigned long *TagDataSize);

[C++ (DLL/Lib)]
    unsigned long GetFileTagInfo( unsigned short *fileName, unsigned short TagID, bool* TagExists);

[C++ (VCL)]
    unsigned long __fastcall GetFileTagInfo( const TSolFSString FileName, unsigned short TagID, bool &TagExists );

[C++ (.NET)]
    long GetFileTagInfo( String *fileName, int TagID, bool& TagExists );

    int GetFileTagInfo( String fileName, int TagID, out bool TagExists );

    Function GetFileTagInfo(ByVal fileName As String, TagID As Integer, ByRef TagExists As Boolean ) As Integer

    long getFileTagInfo( String fileName, int tagID)


  • FileName - the full file name in the SolFSStorage.
  • TagID - tag unique ID, must be in range of [0x8000..0xCFFF].
  • TagExists - on exit is set to true if the tag exists and false otherwise.
  • [Plain C] Storage - handle to the storage returned by Create or Open function.
  • [Plain C] TagDataSize - On exit contains tag data real size

Return value

Tag data real size.

     [Java]  Tag data size if tag exists or -1 if the tag doesn't exist.
     [Plain C]  0 if the function succeeded or one of Error codes if the function failed.


Use GeFileTagInfo to retrieve size of file metadata (custom tag). Each file can have up to 20480 tags. Each tag data can be as large as (PageSize - 48) bytes.

See also

GetFileTag SetFileTag DeleteFileTag