VCOM:VectorWorks:Extension:IDBDatabase::ListTables

From Vectorworks Developer
Jump to navigation Jump to search

.SDK|SDK ..SDK:Types|SDK Types ..VCOM:VCOM (Vectorworks Component Object Model)|VCOM Basics ..VCOM:Class Reference|VCOM Class Reference

Description

namespace VectorWorks::Extension

Member of VCOM:VectorWorks:Extension:IDBDatabase

Returns a list of table names in the data source.

virtual VCOMError VCOM_CALLTYPE ListTables(
bool includeViews,
bool includeSystemTables,
TXStringArray& outArrTables) = 0;

Parameters

includeViews bool Include views as tables in the result list.
includeSystemTables bool Include system tables in the result list.
outArrTables TXStringArray& Result list.

Return Value

Uses standard VCOM Error Reporting.

Return value meaning:

kVCOMError_NotInitialized Bad VCOM instance used to call the function.
kVCOMError_Failed Routine failed.
kVCOMError_NoError Routine succeeded.