VCOM:VectorWorks:Extension:IDBDatabase::ListAllColumnsN: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
No edit summary |
||
| Line 10: | Line 10: | ||
Member of [[VCOM:VectorWorks:Extension:IDBDatabase]] | Member of [[VCOM:VectorWorks:Extension:IDBDatabase]] | ||
Returns a list of columns in the table. | |||
</desc> | </desc> | ||
| Line 16: | Line 16: | ||
<def> | <def> | ||
<funcDef lang="cpp"> | <funcDef lang="cpp"> | ||
virtual | virtual VCOMError VCOM_CALLTYPE ListAllColumnsN(const TXString& inTableName, bool inIdentifyKeyColumns, int driverNotToDoTheJob, TVWArray_DBTableColumn& outArrColumns) = 0; | ||
</funcDef> | </funcDef> | ||
</def> | </def> | ||
| Line 26: | Line 26: | ||
inTableName | inTableName | ||
const [[SDK:TXString]]& | const [[SDK:TXString]]& | ||
Table name. | |||
</line> | </line> | ||
<line> | <line> | ||
inIdentifyKeyColumns | inIdentifyKeyColumns | ||
bool | bool | ||
Do identify possible key columns or not. | |||
</line> | </line> | ||
<line> | <line> | ||
driverNotToDoTheJob | driverNotToDoTheJob | ||
int | int | ||
Driver number to execute the query. | |||
</line> | </line> | ||
<line> | <line> | ||
outArrColumns | outArrColumns | ||
TVWArray_DBTableColumn& | TVWArray_DBTableColumn& | ||
The list of columns. | |||
</line> | </line> | ||
</lineList> | </lineList> | ||
| Line 54: | Line 54: | ||
<line> | <line> | ||
kVCOMError_NotInitialized | kVCOMError_NotInitialized | ||
Bad VCOM instance used to call the | Bad VCOM instance used to call the function. | ||
</line> | </line> | ||
<line> | <line> | ||
| Line 60: | Line 60: | ||
Routine failed. | Routine failed. | ||
</line> | </line> | ||
<line> | |||
kVCOMError_NoError | |||
Routine succeeded. | |||
</line> | |||
</lineList> | </lineList> | ||
</return> | </return> | ||
Latest revision as of 12:17, 2 November 2015
.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.