Datasnap.DBClient.TCustomClientDataSet.SetOptionalParam
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);
Propriétés
Type | Visibilité | Source | Unité | Parent |
---|---|---|---|---|
procedure function |
public | Datasnap.DBClient.pas Datasnap.DBClient.hpp |
Datasnap.DBClient | TCustomClientDataSet |
Description
Enregistre un paramètre personnalisé avec le paquet de données.
Vous pouvez ajouter des informations personnalisées à un paquet de données en utilisant la méthode SetOptionalParam. 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. Par exemple, en initialisent un paramètre dans l'événement OnGetData d'un fournisseur, un serveur d'application peut inclure des informations personnalisées dans le paquet de données qui est envoyé aux applications client. 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 sont stockées. Ce peut être une valeur quelconque à l'exception des libellés suivants :
UNIQUE_KEY |
DEFAULT_ORDER |
CHANGE_LOG |
SERVER_COL |
CONSTRAINTS |
DATASET_CONTEXT |
DATASET_DELTA |
LCID |
BDERECORD_X |
TABLE_NAME |
MD_FIELDLINKS |
UPDATEMODE |
Le paramètre Value est un OleVariant qui représente les informations personnalisées.
Le paramètre IncludeInDelta spécifie si le paramètre est également stocké avec la propriété Delta. En incluant le paramètre dans la propriété Delta, il est envoyé avec les mises à jour au fournisseur. Le fournisseur peut ainsi récupérer ces informations en utilisant la méthode GetOptionalParam de l'ensemble de données client transmis comme paramètre à un gestionnaire d'événement OnUpdateData.
Remarque : Ne confondez pas les données optionnelles enregistrées par cette méthode avec la propriété Params.