Datasnap.Xmlxform.TXMLTransformClient.SetParams

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi

procedure SetParams(const ParamsXml, ParamsTransformFile: string);

C++

void __fastcall SetParams(const System::UnicodeString ParamsXml, const System::UnicodeString ParamsTransformFile);

Propriétés

Type Visibilité  Source Unité  Parent
procedure
function
public
Datasnap.Xmlxform.pas
Datasnap.Xmlxform.hpp
Datasnap.Xmlxform TXMLTransformClient

Description

Définit les paramètres d'entrée des valeurs fournies dans un document XML.

Appelez SetParams pour fournir les valeurs de paramètres d'entrée avant d'extraire des données du fournisseur. Les valeurs de paramètres peuvent représenter les paramètres d'entrée d'une requête ou procédure stockée, ou des valeurs de champ qui filtrent les données lorsque le fournisseur représente les données d'un composant TTable ou TSQLTable.

ParamsXML est le document XML qui représente les valeurs de paramètre à définir. Généralement, il renferme le contenu d'un fichier de document XML.

ParamsTransformFile est le nom d'un fichier de transformation qui convertit ParamsXml en un paquet de données. Un fichier de transformation est un type spécial de fichier XML portant l'extension .xtr. Le fichier de transformation est spécifique à un schéma XML et à un format de paquet de données. Utilisez l'utilitaire xmlmapper.exe pour créer le fichier de transformation.

Remarque :  Si ParamsTransformFile comprend des conversions définies par l'utilisateur, le composant spécifié par TransformSetParams génère un événement OnTranslate lorsqu'il doit transformer les noeuds définis par l'utilisateur dans la chaîne ParamsXml en valeurs de paramètres correspondantes.

Le composant TXMLTransformClient stocke les valeurs de paramètres de manière interne. Chaque fois que vous appelez SetParams, vous mettez à jour ces valeurs stockées de manière interne. Les valeurs de paramètres issues d'appels antérieurs n'étant pas effacées, veillez à définir chaque valeur à modifier.

La prochaine fois que la méthode GetDataAsXml est appelée, TXMLTransformClient envoie au fournisseur les valeurs de paramètres stockées.

Voir aussi