Datasnap.DBClient.TCustomClientDataSet.GetOptionalParam

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi

function GetOptionalParam(const ParamName: string): OleVariant;

C++

System::OleVariant __fastcall GetOptionalParam(const System::UnicodeString ParamName);

Propriétés

Type Visibilité  Source Unité  Parent
function public
Datasnap.DBClient.pas
Datasnap.DBClient.hpp
Datasnap.DBClient TCustomClientDataSet

Description

Récupère un paramètre personnalisé dans le paquet de données.

Les développeurs d'application peuvent ajouter des informations personnalisées à un paquet de données en utilisant la méthode SetOptionalParam de l'ensemble de données client ou l'événement OnGetDataSetProperties d'un fournisseur. Ces informations sont enregistrées avec le paquet de données quand il est enregistré dans un fichier ou un flux et copiées avec la valeur de la propriété Data. Appelez la méthode GetOptionalParam pour récupérer ces informations personnalisées dans le paquet de données.

Le paramètre ParamName spécifie le nom sous lequel les informations personnalisées ont été stockées.

Remarque :  Ne confondez pas les données optionnelles récupérées par cette méthode avec la propriété Params.

Voir aussi