RAD Studio VCL Reference
ContentsIndex
PreviousUpNext
TCustomClientDataSet.GetOptionalParam Method
TCustomClientDataSet Class | TCustomClientDataSet Members | DBClient Namespace | Description | See Also
Collapse All

Retrieves a custom parameter from the data packet.

Pascal
function GetOptionalParam(const ParamName: string): OleVariant;
C++
__fastcall OleVariant GetOptionalParam(const AnsiString ParamName);
Description

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.
 

 

See Also

SetOptionalParam 

Data 

OnGetDataSetProperties 

Adding Application-specific Information to the Data 

Adding Custom Information to Data Packets

Copyright(C) 2008 CodeGear(TM). All Rights Reserved.
What do you think about this topic? Send feedback!