Datasnap.DBClient.TCustomClientDataSet.StatusFilter

From RAD Studio API Documentation
Jump to: navigation, search

[–] Properties
Type: property
Visibility: public
Source:
Datasnap.DBClient.pas
Datasnap.DBClient.hpp
Unit: Datasnap.DBClient
Parent: TCustomClientDataSet

Delphi

property StatusFilter: TUpdateStatusSet read FStatusFilter write SetStatusFilter;

C++

__property Data::Db::TUpdateStatusSet StatusFilter = {read=FStatusFilter, write=SetStatusFilter, nodefault};

Description

Filters the client dataset so that it exposes only those records with a specific update status.

Use StatusFilter to limit the client dataset to records that represent a specific update status. This can be useful when processing updates in a provider's event handlers (or, if the client dataset has an internal provider, in its own BeforeUpdateRecord event handler).

StatusFilter is a set of TUpdateStatus values. It can indicate more than one type of update. If StatusFilter is an empty set (the default), the client dataset appears as if all updates in the change log have been incorporated.

Including usUnmodified in StatusFilter has no effect.

See Also