SolFSStorage.GetFileTagAsString method


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

SolFSStorage     See also    


Returns value of the UNICODE string tag.


    function GetFileTagAsString( const FileName : TSolFSString; const TagName : TSolFSString; TagID : Word ): TSolFSString;

[Plain C]
    long _stdcall StorageGetFileTagAsString( Handle Storage, PWideChar FileName, PWideChar TagName, Word TagID, PWideChar ValueBuffer, PWideChar *ValueBufferSize );

[C++ (DLL/Lib)]
    void GetFileTagAsString( const PWideChar FileName, const PWideChar TagName, unsigned short TagID, PWideChar &Value );

[C++ (VCL)]
    TSolFSString __fastcall GetFileTagAsString( const TSolFSString FileName, const TSolFSString TagName, Word TagID );

[C++ (.NET)]
    String *GetFileTagAsString( String *fileName, String *tagName, int tagID );

    string GetFileTagAsString( string fileName, string tagName, int tagID );

    Function GetFileTagAsString( ByVal fileName As String, ByVal tagName As String, ByVal tagID As Integer ) As String

    String getFileTagAsString( String fileName, String tagName, int tagID)


  • [Plain C] Storage - handle to the storage returned by Create or Open function.
  • [Plain C] ValueBuffer - buffer containing tag value.
  • [Plain C] ValueBufferSize - size of the buffer containing tag value.
  • [C++ (DLL/Lib)] Value - tag value.
  • FileName - the full file name in the SolFSStorage.
  • TagName - name of the tag or empty value, if TagID is to be used.
  • TagID - tag unique ID, must be in range of [0x8000..0xCFFF].

Return value

    Tag value.

     [Plain C]  0 if the function succeeded or one of Error codes if the function failed.


Use this method to get values of UNICODE string tag. You need to specify either TagName (in this case TagID parameter is ignored) or TagID (in this case TagName parameter is ignored).

See also