GetValue method: Business Interlink class

Syntax

GetValue(paramname, value)

Description

The GetValue method gets a value from an output parameter within a document of the Output structure for a Business Interlink object.

Parameters

Parameter	Description
Paramname	The name of the member of the document that is having a value retrieved from it.
Value	The value that is retrieved. This can be a variable or a record field. The data type can be String, Integer, Double, Float, Time, Date, or DateTime.

Returns

The following are the possible return values:

Example

In the following example, the Business Interlink object name is QE_COST.

In the following example, the Output structure for Calculate Cost, or the root level document, is created with the GetOutputDocs method. (If you wanted to create, or get, more Output structures, you would call GetNextDoc.) The Calculate Cost output parameter Service_Rate is a document, so the GetDoc method gets it from the Output structure. Then the GetValue method gets values from each of the Service_Rate document members.

Local Interlink &QE_COST; 
Local BIDocs &CalcCostOut; 
Local BIDocs &ServiceRateDoc; 
Local number &ret; 
&QE_COST = GetInterlink(Interlink.QE_COST_EX); 
// Get inputs, execute. (code not shown) 
&CalcCostOut = &QE_COST.GetOutputDocs(""); 
&ret = &CalcCostOut.GetValue("output_param1",&PARAM1); 
 
&ServiceRateDoc = &CalcCostOut.GetDoc("Service_Rate"); 
&ret = &ServiceRateDoc.GetValue("Service_Type", &SERVICE_TYPE); 
&ret = &ServiceRateDoc.GetValue("Rate", &RATE); 
 
/* Call GetDoc, GetValue, GetNextDoc for output_param2_List (code not shown) */ 

The following illustration shows the Output structure for this example. It contains three output parameters: output_param1, Service_Rate, and output_param2_List. This is a version of the Federal Express plug-in that was modified for this example (output_param1 and output_param2_List were added).

Return Status for Integer

Number	Enum value and Meaning
0	NoError. The method succeeded.
1	NO_DOCUMENT. The document referenced by this method does not exist.
9	NO_DATA. You tried to retrieve data from a document that contained no data.
10	GENERIC_ERROR. There was an error with the transaction.