VCOM:VectorWorks:Extension:IDBDatabase::GetDriverInfo: 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...
Gets driver info and details.
</desc>
</desc>


Line 16: Line 16:
<def>
<def>
<funcDef lang="cpp">
<funcDef lang="cpp">
virtual VCOMErrorVCOM_CALLTYPE GetDriverInfo(TXString& outDriverName, TXString& outDriverID, TXString& outServer, TXString& outDatabase) = 0;
virtual VCOMError VCOM_CALLTYPE GetDriverInfo(TXString& outDriverName, TXString& outDriverID, TXString& outServer, TXString& outDatabase) = 0;
</funcDef>
</funcDef>
</def>
</def>
Line 26: Line 26:
outDriverName
outDriverName
[[SDK:TXString]]&
[[SDK:TXString]]&
no info.
Out parameter - driver name.
</line>
</line>
<line>
<line>
outDriverID
outDriverID
[[SDK:TXString]]&
[[SDK:TXString]]&
no info.
Out parameter - driver number.
</line>
</line>
<line>
<line>
outServer
outServer
[[SDK:TXString]]&
[[SDK:TXString]]&
no info.
Out parameter - server name.
</line>
</line>
<line>
<line>
outDatabase
outDatabase
[[SDK:TXString]]&
[[SDK:TXString]]&
no info.
Out parameter - data source name.
</line>
</line>
</lineList>
</lineList>
Line 48: Line 48:
-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<return>
<return>
Uses standard [[VCOM:VCOMError|VCOM Error Reporting]].
Returns '''true''' if succeeded.
 
Return value meaning:
<lineList ident=1>
<line>
kVCOMError_NotInitialized
Bad VCOM instance used to call the fuction.
</line>
<line>
kVCOMError_Failed
Routine failed.
</line>
</lineList>
</return>
</return>


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

Gets driver info and details. 

virtual VCOMError VCOM_CALLTYPE GetDriverInfo(
                        TXString&   outDriverName,
                        TXString&   outDriverID,
                        TXString&   outServer,
                        TXString&   outDatabase) = 0;

Parameters

outDriverName SDK:TXString& Out parameter - driver name.
outDriverID SDK:TXString& Out parameter - driver number.
outServer SDK:TXString& Out parameter - server name.
outDatabase SDK:TXString& Out parameter - data source name.

Return Value

Returns true if succeeded.

Retrieved from "http://developer.vectorworks.net/index.php?title=VCOM:VectorWorks:Extension:IDBDatabase::GetDriverInfo&oldid=20677"