CallbackFilter.GetPassThroughRule method


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

CallbackFilter     See also    


Returns the passthrough rule with given index.


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

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

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

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

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

    Function GetPassThroughRule( ByVal Index As Int32, ByRef Mask As Integer, ByRef AccessFlag As CbFltAccessFlags, ByRef CallbackFlag As CbFltCallbackFlags, ByRef NotifyFlag As CbFltNotifyFlags) As Boolean


  • Index - index of the rule
  • Mask - contains the mask of the files to apply the filter to
  • AccessFlag - access filter flag
  • CallbackFlag - callback filter flag
  • NotifyFlag - notification 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 passthrough rule by given index.

[C++ (Lib)]
To free buffer, allocated for Mask parameter, use free() function.

See also

DeletePassThroughRule     DeleteAllPassThroughRules     AddPassThroughAccessRule     AddPassThroughCallbackRule