VCOM:VectorWorks:Extension:IDBDatabase::Connect: 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...
The function connects to a data source.
</desc>
</desc>


Line 26: Line 26:
dsn
dsn
const [[SDK:TXString]]&
const [[SDK:TXString]]&
no info.
Data Source name.
</line>
</line>
<line>
<line>
user
user
const [[SDK:TXString]]&
const [[SDK:TXString]]&
no info.
User name. Pass empty string if no username.
</line>
</line>
<line>
<line>
password
password
const [[SDK:TXString]]&
const [[SDK:TXString]]&
no info.
Password. Pass empty string if no password.
</line>
</line>
</lineList>
</lineList>
Line 49: Line 49:
<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>
kVCOMError_Failed
kVCOMError_Failed
Routine failed.
Routine failed.
</line>
<line>
kVCOMError_NoError
Routine succeeded.
</line>
</line>
</lineList>
</lineList>

Latest revision as of 09:07, 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

The function connects to a data source.

virtual VCOMErrorVCOM_CALLTYPE Connect(
const TXString& dsn,
const TXString& user,
const TXString& password) = 0;

Parameters

dsn const SDK:TXString& Data Source name.
user const SDK:TXString& User name. Pass empty string if no username.
password const SDK:TXString& Password. Pass empty string if no password.

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.