SolFSStorage.SetFileTagAsBoolean method


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

SolFSStorage     See also    


Assigns value to the Boolean tag.


    procedure SetFileTagAsBoolean( const FileName : TSolFSString; const TagName : TSolFSString; TagID : Word; Value : boolean );

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

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

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

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

    void SetFileTagAsBool( string fileName, string tagName, int tagID, bool value );

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

    void setFileTagAsBoolean( String fileName, String tagName, int tagID, boolean 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 Boolean tag value. You need to specify either TagName (in this case TagID parameter is ignored) or TagID (in this case TagName parameter is ignored).

See also