RAD Studio VCL Reference
ContentsIndex
PreviousUpNext
TXMLBroker.Params Property

Contains parameter values that are sent to or retrieved from the application server.

Pascal
property Params: TXMLParams;
C++
__property TXMLParams Params;

Use Params to specify parameter values that should be passed to a source dataset on the application server. These parameter values are used in one of two ways: 

If the associated provider represents a query or stored procedure, they supply parameter values that the application server uses when executing the query or stored procedure. 

If the associated provider represents a table, they limit the records that are sent in data packets so that they only include records where each field with the same name as a parameter has the same value as the parameter. 

After the application specifies parameters (at design time or runtime), they are sent to the application server automatically when the XML broker fetches data. 

To send parameter values to a query or stored procedure, add a parameter object (TParam) to Params for every parameter on the query or stored procedure for which you want to supply a value. Assign each parameter object the same Name, DataType, and ParamType as the corresponding parameter on the query or stored procedure. These values are automatically encoded and sent to the application server when the XML broker fetches data. 

To send parameter values to a table, add a parameter object for each field in the table that is used to limit the values sent in data packets. Assign each parameter object the same Name and DataType as the corresponding field component on the table. These parameter values are automatically sent when the client dataset fetches data, and the records returned in data packets from the application server only contain records that match the assigned value on the corresponding fields.

Tip: You can assign parameter values from the content fields supplied to a request message by TSubmitQueryButton using the AssignStrings method of Params.
Note: To initialize Params so that it reflects the parameters of a query or stored procedure on an application server, call the FetchParams method.
 

 

Copyright(C) 2009 Embarcadero Technologies, Inc. All Rights Reserved.
What do you think about this topic? Send feedback!