VCOM:VectorWorks:Extension:IDBDatabase::ListAllColumnsN

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 columns in the table.

virtual VCOMError VCOM_CALLTYPE ListAllColumnsN(
const TXString& inTableName,
bool inIdentifyKeyColumns,
int driverNotToDoTheJob,
TVWArray_DBTableColumn& outArrColumns) = 0;

Parameters

inTableName const SDK:TXString& Table name.
inIdentifyKeyColumns bool Do identify possible key columns or not.
driverNotToDoTheJob int Driver number to execute the query.
outArrColumns TVWArray_DBTableColumn& The list of columns.

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.