VCOM:VectorWorks:Extension:IDBDatabase::Execute: Difference between revisions

From Vectorworks Developer
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]]


...put some description here...
Executes a query.
</desc>
</desc>


Line 17: Line 17:
<funcDef lang="cpp">
<funcDef lang="cpp">
virtual VCOMErrorVCOM_CALLTYPE Execute(const TXString& sql) = 0;
virtual VCOMErrorVCOM_CALLTYPE Execute(const TXString& sql) = 0;
</funcDef>
<funcDef lang="cpp">
virtual VCOMErrorVCOM_CALLTYPE Execute(const TXString& sql, Sint32& outResultCount) = 0;
</funcDef>
</funcDef>
</def>
</def>
Line 26: Line 30:
sql
sql
const [[SDK:TXString]]&
const [[SDK:TXString]]&
no info.
Query to execute.
</line>
</line>
<line>
outResultCount
[[Sint32]]&
Out parameter - number of results.
</line>
</lineList>
</lineList>
</params>
</params>
Line 39: Line 50:
<line>
<line>
kVCOMError_NotInitialized
kVCOMError_NotInitialized
Bad VCOM instance used to call the fuction.
Bad VCOM instance used to call the function.
</line>
</line>
<line>
<line>
Line 45: Line 56:
Routine failed.
Routine failed.
</line>
</line>
<line>
kVCOMError_NoError
Routine succeeded.
</line>
</lineList>
</lineList>
</return>
</return>

Latest revision as of 12:31, 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

Executes a query.

virtual VCOMErrorVCOM_CALLTYPE Execute(
const TXString& sql) = 0;
virtual VCOMErrorVCOM_CALLTYPE Execute(
const TXString& sql,
Sint32& outResultCount) = 0;

Parameters

sql const SDK:TXString& Query to execute.
outResultCount Sint32& Out parameter - number of results.

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.