Datasnap.DBClient.TCustomClientDataSet.GetOptionalParam
Delphi
function GetOptionalParam(const ParamName: string): OleVariant;
C++
System::OleVariant __fastcall GetOptionalParam(const System::UnicodeString ParamName);
Eigenschaften
| Typ | Sichtbarkeit | Quelle | Unit | Übergeordnet |
|---|---|---|---|---|
| function | public | Datasnap.DBClient.pas Datasnap.DBClient.hpp |
Datasnap.DBClient | TCustomClientDataSet |
Beschreibung
Ruft einen benutzerdefinierten Parameter aus dem Datenpaket ab.
Anwendungsentwickler können mit der Methode SetOptionalParam der Client-Datenmenge oder dem Ereignis OnGetDataSetProperties eines Providers benutzerdefinierte Informationen in das Datenpaket einfügen. Diese Informationen werden mit dem Datenpaket in einer Datei oder einem Stream gespeichert und mit dem Wert der Eigenschaft Data kopiert. Durch einen Aufruf von GetOptionalParam können Sie diese benutzerdefinierten Informationen aus dem Datenpaket abrufen.
Der Parameter ParamName gibt den Namen an, unter dem die benutzerdefinierten Informationen gespeichert wurden.
Anmerkung: Verwechseln Sie die mit dieser Methode abgerufenen optionalen Daten nicht mit der Eigenschaft Params.