Kdtop at 17:56, 4 July 2015

2015-07-04T17:56:23Z

← Older revision		Revision as of 17:56, 4 July 2015
Line 1:		Line 1:
	<h2>Param Property</h2>		<h2>Param Property</h2>
	Example		[[RPC_HELP_TRPCBroker_Param_Example\|Example]]

	<h3>Applies to</h3>		<h3>Applies to</h3>

Kdtop: Created page with "

Param Property

Example

Applies to

TRPCBroker component

Declaration

property Param: TParams; ..."

2015-07-04T17:55:28Z

Created page with "<h2>Param Property</h2> Example <h3>Applies to</h3> TRPCBroker component <h3>Declaration</h3> property Param: TParams; ..."

New page

<h2>Param Property</h2>
Example

<h3>Applies to</h3>
[[RPC_HELP_TRPCBroker|TRPCBroker]] component

<h3>Declaration</h3>
property Param: [[RPC_HELP_TParams|TParams]];

<h3>Description</h3>
The Param property is available at run-time only. It holds all of the parameters that the application needs to pass to the remote procedure using the [[RPC_HELP_TRPCBroker_Call_Method|Call]], [[RPC_HELP_TRPCBroker_strCall_Method|strCall]], or [[RPC_HELP_TRPCBroker_lstCall_Method|lstCall]] methods.

Param is a zero-based array of [[RPC_HELP_TParamRecord|TParamRecord]]. You don't need to explicitly allocate any memory for the Param property. Simple reference to an element or a value assignment ( := ) dynamically allocates memory as needed. You should start with the 0th element and proceed in sequence. Do ''not'' skip elements.

Each element in the Param array has the following properties:
* [[RPC_HELP_TParamRecord_Mult_Property|Mult]]
* [[RPC_HELP_TParamRecord_PType_Property|PType]]
* [[RPC_HELP_TParamRecord_PType_Property|PType]]

Passing multiple parameters of PType list in one remote procedure call ([[RPC_HELP_RPCs|RPC]]) is not supported at this time. Only one list parameter can be passed to an RPC, and it must be the last parameter in the actual list.

The Param relationship to the [[RPC_HELP_TRPCBroker|TRPCBroker]] component is as follows:
* The [[RPC_HELP_TRPCBroker|TRPCBroker]] component contains the Param property (i.e., [[RPC_HELP_TParams|TParams]] class).
** The [[RPC_HELP_TParams|TParams]] class contains the ParamArray property (array [I:integer]: [[RPC_HELP_TParamRecord|TParamRecord]] class).
*** The [[RPC_HELP_TParamRecord|TParamRecord]] class contains the [[RPC_HELP_TParamRecord_Mult_Property|Mult]] property (i.e., [[RPC_HELP_TMult|TMult]] class).
**** The [[RPC_HELP_TMult|TMult]] class contains the MultArray property (array[S: string]: string).
***** The MultArray property internally uses a TStringList in which each element’s object is a TString.

If the remote procedure on the VistA M Server does not require any incoming parameters, applications can pass an empty Param property. The client application merely sets the [[RPC_HELP_TRPCBroker_RemoteProcedure|RemoteProcedure]] property and makes the call. If the Param property retains a value from a previous call, it can be cleared using the [[RPC_HELP_TRPCBroker_ClearParameters_Example|Example]] property. Thus, it is possible to make a call without passing any parameters.

NOTE: The following restrictions apply with the Param property:
'''# You are not allowed to "skip" passing parameters, such as TAG^ROUTINE(1,,3), where you can skip passing the second parameter in DSM code. If you have fewer elements in your Param array than exist as input parameters in your RPC, the subsequent parameters will not be passed to the [[RPC_HELP_RPCs|RPC]].
# Passing multiple array parameters in one remote procedure call is not supported at this time. Only one array parameter can be passed to an [[RPC_HELP_RPCs|RPC]], and it must be the last parameter in the actual list.
'''
NOTE: For a demonstration using the Param property, please run the BrokerExample.EXE located in the ..\BDK32\Samples\BrokerEx directory.

RPC HELP TRPCBroker Param - Revision history

Kdtop at 17:56, 4 July 2015

Kdtop: Created page with "

Param Property

Applies to

Declaration