SQL::Connection::GetTableInfo()

Syntax

Result_Flag as L = <SQL::Connection>.GetTableInfo( BYREF <TableInfo> as SQL::TableInfo, TableName as C, [ TableOwner as C ] )

Argument

Description

Result_Flag

TRUE (.T.) if the operation was successful; otherwise FALSE (.F.).

<SQL::Connection>

A SQL::Connection object.

<TableInfo>

A SQL::TableInfo object to define TableName.

TableOwner

The owner of the table.

TableName

Optional. Default = "". The name of the table containing the data.

Description

The GetTableInfo() method retrieves the definition of a table.

Supported By

Alpha Five Version 8 Enterprise Edition

Limitations

Desktop applications only.

Example

dim conn as SQL::Connection

dim ti as SQL::TableInfo

dim connString as C

connString = "{A5API='Access', FileName='c:\program files\a5v8\mdbfiles\alphasports.mdb'}"

if .not. conn.open(connString)

    ui_msg_box("Error", conn.CallResult.text)

    end

end if

if .not. conn.GetTableInfo(ti, "customer")

    ui_msg_box("Error", conn.CallResult.text)

end if

ui_msg_box("Table Information", ti.xml)

conn.close()

See Also

SQL::Connection Object