CallbackFilter.GetFilterRuleEx method


Pascal    C++ (Lib)    C++ (VCL)    C++ (.NET)    C#    VB.NET   

CallbackFilter     See also    


Returns the filter rule with given index and EA name.


    function GetFilterRuleEx(Index : integer; var Mask : TCBString; var EaName : AnsiString; var AccessFlag : LongWord; var CallbackFlag : LongWord; var NotifyFlag : LongWord ): boolean;
    type TCBString = {$ifdef UNICODE}UnicodeString{$else}WideString{$endif};

[C++ (Lib)]
    bool GetFilterRuleEx(int Index, LPWSTR* Mask, LPSTR* EaName, CbFltAccessFlags* AccessFlag, CbFltCallbackFlags* CallbackFlag, CbFltNotifyFlags* NotifyFlag);

[C++ (VCL)]
    bool __fastcall GetFilterRuleEx(int Index, WideString &Mask, AnsiString* EaName, unsigned long &AccessFlag, unsigned long &CallbackFlag, unsigned long &NotifyFlag );

[C++ (.NET)]
    bool GetFilterRuleEx(int32 Index, String^% Mask, String^% EaName, CbFltAccessFlags% AccessFlag, CbFltCallbackFlags% CallbackFlag, CbFltNotifyFlags% NotifyFlag);

    bool GetFilterRuleEx(int32 Index, ref string Mask, ref string EaName, ref CbFltAccessFlags AccessFlag, ref CbFltCallbackFlags CallbackFlag, ref CbFltNotifyFlags NotifyFlag);

    Function GetFilterRuleEx( ByVal Index As Int32, ByRef Mask As String, ByRef EaName As String, ByRef AccessFlag As CbFltAccessFlags, ByRef CallbackFlag As CbFltCallbackFlags, Byref NotifyFlag As CbFltNotifyFlags ) As Boolean


  • Index - index of the rule
  • Mask - contains mask of the files to apply the filter to
  • EaName - contains the name of the extended attribute which must be present for the file
  • AccessFlag - access filter flag
  • CallbackFlag - callback filter flag
  • NotifyFlag - notify filter flag

Return values

TRUE / true if the function succeeded or FALSE / false if the function failed.

AccessFlag values

CallbackFlag values

NotifyFlag values


Use this method to get the filter rule by given index and extended attribute name.

[C++ (Lib)]
To free the buffers, allocated for Mask and EaName parameters, use free() function.

See also

DeleteFilterRule     DeleteAllFilterRules     AddFilterAccessRuleEx     AddFilterRuleEx