SolFSStorage.GetFileTagAsBoolean method


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

SolFSStorage     See also    


Returns value of the boolean tag.


    function GetFileTagAsBoolean( const FileName : TSolFSString; const TagName : TSolFSString; TagID : Word ): boolean;

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

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

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

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

    bool GetFileTagAsBool( string fileName, string tagName, int tagID );

    Function GetFileTagAsBool( ByVal fileName As String, ByVal tagName As String, ByVal tagID As Integer ) As Boolean

    boolean getFileTagAsBool( String fileName, String tagName, int tagID)


  • [Plain C] Storage - handle to the storage returned by Create or Open function.
  • [Plain C] Value - Value of the tag.
  • 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 boolean 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