SolFSStorage.SetFileTagAsAnsiString method


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

SolFSStorage     See also    


Assigns a value to the ANSI string tag.


    procedure SetFileTagAsAnsiString( const FileName : TSolFSString; const TagName : TSolFSString; TagID : Word; Value : AnsiString );

[Plain C]
    long _stdcall StorageSetFileTagAsAnsiString( Handle Storage, PWideChar FileName, PWideChar TagName, Word TagID, PChar Value );

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

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

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

    void SetFileTagAsAnsiString( string fileName, string tagName, int tagID, string value );

    Sub SetFileTagAsAnsiString( ByVal fileName As String, ByVal tagName As String, ByVal tagID As Integer, ByVal value As String )

    void setFileTagAsAnsiString( String fileName, String tagName, int tagID, String value)


  • [Plain C] Storage - handle to the storage returned by Create or Open function.
  • FileName - the full file name in the SolFSStorage.
  • TagName - tag name 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.
  • Value - value to be assigned to the tag.

Return value

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


Use this method to set the ANSI string tag value. 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

SetFileTagAsString     GetFileTagAsAnsiString