Datasnap.DBClient.TCustomClientDataSet.SetOptionalParam

Übergeordnet: TCustomClientDataSet

Delphi

procedure SetOptionalParam(const ParamName: string; const Value: OleVariant;  IncludeInDelta: Boolean = False); virtual;

C++

virtual void __fastcall SetOptionalParam(const System::UnicodeString ParamName, const System::OleVariant &Value, bool IncludeInDelta = false);

Eigenschaften

Typ	Sichtbarkeit	Quelle	Unit	Übergeordnet
procedure function	public	Datasnap.DBClient.pas Datasnap.DBClient.hpp	Datasnap.DBClient	TCustomClientDataSet

Beschreibung

Speichert einen benutzerdefinierten Parameter im Datenpaket.

Mit der Methode SetOptionalParam können Sie benutzerdefinierte Informationen in ein Datenpaket einfügen. Diese Informationen werden mit dem Datenpaket in einer Datei oder einem Stream gespeichert und mit dem Wert der Eigenschaft Data kopiert. Wird beispielsweise im Ereignis OnGetData des Providers ein Parameter festgelegt, können Anwendungsserver benutzerdefinierte Informationen in die Daten einfügen, die an Client-Anwendungen gesendet werden. Durch einen Aufruf von GetOptionalParam können Sie die benutzerdefinierten Informationen aus dem Datenpaket abrufen.

Der Parameter ParamName gibt den Namen an, unter dem die benutzerdefinierten Informationen gespeichert werden. Jeder Wert außer den folgenden ist möglich:

UNIQUE_KEY	DEFAULT_ORDER	CHANGE_LOG	SERVER_COL
CONSTRAINTS	DATASET_CONTEXT	DATASET_DELTA	LCID
BDERECORD_X	TABLE_NAME	MD_FIELDLINKS	UPDATEMODE

Der Parameter Value ist ein Wert des Typs OleVariant, der die benutzerdefinierten Informationen repräsentiert.

Der Parameter IncludeInDelta gibt an, ob der Parameter auch in der Eigenschaft Delta gespeichert wird. In diesem Fall wird er zusammen mit Aktualisierungen an den Provider gesendet. Der Provider kann diese Informationen dann mit der Methode GetOptionalParam der Client-Datenmenge abrufen, die als Parameter an eine Ereignisbehandlungsroutine für OnUpdateData übergeben wurde.