GetViewJoinInfo()
Summary
Gets the join information for a view.
Syntax
info_array = GetViewJoinInfo(string view_name [, array
opts])
| Argument |
Type |
Contents |
| view_name |
string |
Name of a view |
| Options |
Type |
Contents |
| Linked |
Bool |
True, to get the "JoinLinkedString" from a linked joined view. Default is False. |
Returns
An array. There are five elements for joined views:
| Element |
Type |
Contents |
| 1 |
Array |
The left view info; if the view is a base table, the same array as returned byGetViewTableInfo(), otherwise the same array as returned by GetViewJoinInfo() on that view |
| 2 |
Array |
The names of the fields in the left view on which the join is made |
| 3 |
Array |
The right view info; if the view is a base table, the same array as returned by GetViewTableInfo(), otherwise the same array as returned by GetViewJoinInfo() on that view |
| 4 |
Array |
The names of the fields in the right view on which the join is made |
| 5 |
Array |
The same as the options array toJoinViews()orJoinViewsMulti()used to indicate the type of join |
There are two elements for self-aggregate views:
| Element |
Type |
Contents |
| 1 |
Array |
The base view info, with the same array as returned by GetViewTableInfo() |
| 2 |
Array |
An array of the names of the fields in the base view on which the aggregation is made |
Example
// Open STSALES.DBF and STATES.BIN in the Tutorial folder
jv = JoinViews("Sales Table", "STATES.[Abbrev.]", "STSALE.ABBREV", )
info = GetViewJoinInfo(jv)
ShowArray(info)
// Open CUSTOMER.DBF in the Tutorial folder
sa = SelfAggregate("Group by City", "CUSTOMER.CITY_STATE", )
info = GetViewJoinInfo(sa)
ShowArray(info)
See Also