Datasnap.DBClient.TCustomClientDataSet.GetOptionalParam
Delphi
function GetOptionalParam(const ParamName: string): OleVariant;
C++
System::OleVariant __fastcall GetOptionalParam(const System::UnicodeString ParamName);
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
| function | public | Datasnap.DBClient.pas Datasnap.DBClient.hpp |
Datasnap.DBClient | TCustomClientDataSet |
Description
Retrieves a custom parameter from the data packet.
Application developers can add custom information to the data packet using the client dataset's SetOptionalParam method or a provider's OnGetDataSetProperties event. This information is saved with the data packet when it is saved to a file or stream, and copied with the value of the Data property. Call GetOptionalParam to retrieve this custom information from the data packet.
The ParamName parameter specifies the name under which the custom information was stored.
Note: Do not confuse the optional data retrieved by this method with the Params property.