GetViewTableInfo()

Summary

Gets information about a table.

 

Changes

Additional classes added for Version 5.0.

 

Syntax

info_array = GetViewTableInfo(string view_name)

 

Argument	Contents
view_name	Name of a view containing the table

 

Returns

An array of two elements; or null if the input view is not a table.

 

Element	Type	Contents
1	String	Class name: "DBASE", "FFA", "FFB", "CSV", "EXCEL", "ODBC", "ODBCL", "ORCL", "SDO", "GEODB", "ADO", or "ACCESS", plus "RDM" and "CDF" for layers
2	Array	A specification array that describes the table, in the format required by OpenTable().

 

Notes

• GetViewTableInfo() is a companion function to OpenTable(). Once a table has been opened using OpenTable(), GetViewTableInfo() returns the information necessary to open the same table again.

• GetViewTableInfo() may not return the same specification array that was used to open the table, if there is a difference in case or the specification of drives and paths.

• GetViewTableInfo() works on geographic layers as well as data tables. For geographic layers, the specification array is an array of two strings: the database name and the internal layer name. The class name RDM is used for standard geographic files, the class name CDF is used for compact geographic files.

• For dBASE, fixed-format text (FFA), fixed-format binary (FFB) or comma-separated text (CSV) tables, the specification array is an array of one or two strings. The first string is the primary filename. A second string, if present, indicates the secondary filename (normally used for index files). The second string may not be present if the secondary filename has the default filename for the class.

• For EXCEL, the specification array is an array of two strings: the workbook (.xls) file name and the name of the worksheet in the workbook (with a trailing $) or the named range.

• For ODBC tables, the specification array is an array of four strings: the data source name, the name of the table in the data source, the unique field (if any) declared when the table was opened, and the schema name (if any).

• For ODBCL (ODBC layer) tables, the specification array is an array of three strings plus an array. The strings are the data source name, the schema name, and the name of the table in the data source. The array contains three strings, the names of the ID field, the X coordinate field, and the Y coordinate field.

• For ORCL (Oracle) tables, the specification array is an array of four strings: the service name, the name of the table in the service, the unique field (if any) declared when the table was opened, and the owner name.

• For SDO (Spatial Data Option) tables, the specification array is an array of four strings plus an array. The strings are the service name, the schema name, the layer name, and the layer type, which can be Point, Line, or Area. The array contains two strings, the names of the ID field and the geometry field.

• For GEODB (Esri Personal Geodatabase) tables, the specification array is an array of three strings: the file name, the table name, and the name of the geometry field.

• For ADO (ActiveX Data Objects ) recordsets, the specification array is an array of two strings: the name of the ADO recordset and the name of a field in the ADO recordset containing unique values for each record (if any).

• For ACCESS (Microsoft Access) tables, the specification array is an array of three strings: the file name, the name of the table in the file, and the unique field (if any) declared when the table was opened.

• If the input view_name is null, GetViewTableInfo() uses the current view.

• If the input view is not a table (e.g., it is a joined view), GetViewTableInfo() returns null.

Error Codes

Error Type	Meaning
NotFound	The named view does not exist, or the input view_name is null and there is no current view

 

See Also

Function	Summary
OpenTable()	Opens a table from a file on disk and creates a view
GetViewParents()	Gets the parentage of a view