Data.DBXTransport.TTransportFilterCollection.AddFilter

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function AddFilter(const FilterId: string): Integer; overload; virtual;
function AddFilter(const Filter: TTransportFilter): Integer; overload; virtual;

C++

virtual int __fastcall AddFilter(const System::UnicodeString FilterId)/* overload */;
virtual int __fastcall AddFilter(TTransportFilter* const Filter)/* overload */;

Properties

Type Visibility Source Unit Parent
function public
Data.DBXTransport.pas
Data.DBXTransport.hpp
Data.DBXTransport TTransportFilterCollection

Description

Adds a filter to the current filter collection.

The AddFilter method has two overloads.

The first overload creates a new filter instance and adds it to the current list. The FilterId parameter specifies the new filter's ID.

The second overload adds an existing filter instance, specified through the Filter parameter, to the current collection.

In both cases, the filter list allows duplicates. AddFilter returns the position where the new filter was added, -1 if the parameter is null or empty.

See Also