SolFSStorage.GetFileTagAsString method


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

SolFSStorage     See also    


Returns value of the ANSI string tag.


    function GetFileTagAsAnsiString( const FileName : TSolFSString; const TagName : TSolFSString; TagID : Word ): AnsiString;

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

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

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

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

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

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

    String getFileTagAsAnsiString( 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] or 0 if TagName is to be used.

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 ANSI string tag. You need to specify either TagName (in this case TagID parameter is ignored) or TagID (in this case TagName parameter is ignored).
Note, that in CBFS Storage queries, all ANSI strings are converted to UNICODE. It is recommended to use only ASCII characters in ANSI strings.

See also

GetFileTagAsString     SetFileTagAsAnsiString