VCOM:VectorWorks:Extension:IDBDatabase::ConnectWithBrowserN: 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...
This function works only on Windows. On other platforms returns "not implemented". It uses the OS ODBC API function SQLDriverConnect and it opens the "Select Data Source" dialog.
</desc>
</desc>


Line 16: Line 16:
<def>
<def>
<funcDef lang="cpp">
<funcDef lang="cpp">
virtual VCOMErrorVCOM_CALLTYPE ConnectWithBrowserN(TXString& outConnectionString) = 0;
virtual VCOMError VCOM_CALLTYPE ConnectWithBrowserN(TXString& outConnectionString) = 0;
</funcDef>
</funcDef>
</def>
</def>
Line 26: Line 26:
outConnectionString
outConnectionString
[[SDK:TXString]]&
[[SDK:TXString]]&
no info.
Completed connection string.
</line>
</line>
</lineList>
</lineList>
Line 39: Line 39:
<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 45:
Routine failed.
Routine failed.
</line>
</line>
<line>
kVCOMError_NoError
Routine succeeded.
<line>
</lineList>
</lineList>
</return>
</return>

Revision as of 11:27, 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

This function works only on Windows. On other platforms returns "not implemented". It uses the OS ODBC API function SQLDriverConnect and it opens the "Select Data Source" dialog.

virtual VCOMError VCOM_CALLTYPE ConnectWithBrowserN(
TXString& outConnectionString) = 0;

Parameters

outConnectionString SDK:TXString& Completed connection string.

Return Value

Uses standard VCOM Error Reporting.

Return value meaning:

<line> kVCOMError_NoError Routine succeeded. <line>

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