VCOM:VectorWorks:Extension:IDBDatabase::Connect

.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.