| DBDiagnose | ODBC Vectorworks 2015 |
VectorScript Declaration:
FUNCTION DBDiagnose
:BOOLEAN ; Python:
return BOOLEAN
def vs.DBDiagnose(): Description:
Test ODBC connectivity and creates log file in application folder. Returns true if succeeded.
| DBDocAddConn | ODBC Vectorworks 2011 |
VectorScript Declaration:
FUNCTION DBDocAddConn
( dsn :DYNARRAY[] of CHAR; userName :DYNARRAY[] of CHAR; password :DYNARRAY[] of CHAR ) :BOOLEAN ; Python:
return BOOLEAN
def vs.DBDocAddConn(dsn, userName, password): Description:
Add a database connection to the current document
| DBDocGetColumns | ODBC Vectorworks 2011 |
VectorScript Declaration:
FUNCTION DBDocGetColumns
( database :STRING; table :STRING; VAR outNames :DYNARRAY[] of CHAR; VAR outTypes :DYNARRAY[] of CHAR; VAR outCanBeKey :DYNARRAY[] of CHAR; VAR outIsKey :DYNARRAY[] of CHAR ) :BOOLEAN ; Python:
return (BOOLEAN, outNames, outTypes, outCanBeKey, outIsKey)
def vs.DBDocGetColumns(database, table): Description:
Returns a string representing a ';' delimited lists of the specified table data.
| DBDocGetConn | ODBC Vectorworks 2011 |
VectorScript Declaration:
FUNCTION DBDocGetConn
( databaseName :DYNARRAY[] of CHAR; VAR outUserName :DYNARRAY[] of CHAR; VAR outPassword :DYNARRAY[] of CHAR ) :BOOLEAN ; Python:
return (BOOLEAN, outUserName, outPassword)
def vs.DBDocGetConn(databaseName): Description:
Get database connection info.
| DBDocGetDB | ODBC Vectorworks 2011 |
VectorScript Declaration:
FUNCTION DBDocGetDB
( VAR outDatabases:DYNARRAY[] of CHAR ) :BOOLEAN ; Python:
return (BOOLEAN, outDatabases)
def vs.DBDocGetDB(): Description:
Returns a string representing a ';' delimited list of the databases currectly connected to the document.
| DBDocGetTables | ODBC Vectorworks 2011 |
VectorScript Declaration:
FUNCTION DBDocGetTables
( database :STRING; VAR outTables :DYNARRAY[] of CHAR ) :BOOLEAN ; Python:
return (BOOLEAN, outTables)
def vs.DBDocGetTables(database): Description:
Returns a string representing a ';' delimited list of the tables in the specified database.
| DBDocHasConn | ODBC Vectorworks 2011 |
VectorScript Declaration:
FUNCTION DBDocHasConn
:BOOLEAN ; Python:
return BOOLEAN
def vs.DBDocHasConn(): Description:
Checks if the current document has connections to an ODBC data source.
| DBDocRemoveConn | ODBC Vectorworks 2011 |
VectorScript Declaration:
FUNCTION DBDocRemoveConn
( databaseName:DYNARRAY[] of CHAR ) :BOOLEAN ; Python:
return BOOLEAN
def vs.DBDocRemoveConn(databaseName): Description:
Remove a database connection from the current document
| DBDocSetColKey | ODBC Vectorworks 2011 |
VectorScript Declaration:
FUNCTION DBDocSetColKey
( databaseName :DYNARRAY[] of CHAR; tableName :DYNARRAY[] of CHAR; columnName :DYNARRAY[] of CHAR; setIsKey :BOOLEAN ) :BOOLEAN ; Python:
return BOOLEAN
def vs.DBDocSetColKey(databaseName, tableName, columnName, setIsKey): Description:
Get database table column to be as a key.
| DBGetFormatConn | ODBC Vectorworks 2011 |
VectorScript Declaration:
FUNCTION DBGetFormatConn
( formatName :STRING; VAR outDatabase :STRING; VAR outTable :STRING ) :BOOLEAN ; Python:
return (BOOLEAN, outDatabase, outTable)
def vs.DBGetFormatConn(formatName): Description:
Returns the ODBC connection for the specified format.
| DBGetFormatFieldConn | ODBC Vectorworks 2011 |
VectorScript Declaration:
FUNCTION DBGetFormatFieldConn
( formatName :STRING; VAR fieldName :STRING; VAR columnName :STRING; VAR linkType :INTEGER ) :BOOLEAN ; Python:
return (BOOLEAN, fieldName, columnName, linkType)
def vs.DBGetFormatFieldConn(formatName): Description:
Get ODBC connection for the specified format field.
| DBObjSQLGetRead | ODBC Vectorworks 2011 |
VectorScript Declaration:
FUNCTION DBObjSQLGetRead
( hObject :HANDLE; VAR SQLSentence :DYNARRAY[] of CHAR ) :BOOLEAN ; Python:
return (BOOLEAN, SQLSentence)
def vs.DBObjSQLGetRead(hObject): Description:
Get an object's SQL sentence for ODBC read.
| DBObjSQLGetWrite | ODBC Vectorworks 2011 |
VectorScript Declaration:
FUNCTION DBObjSQLGetWrite
( hObject :HANDLE; VAR SQLSentence :DYNARRAY[] of CHAR ) :BOOLEAN ; Python:
return (BOOLEAN, SQLSentence)
def vs.DBObjSQLGetWrite(hObject): Description:
Get an object's SQL sentence for ODBC write.
| DBObjSQLSetRead | ODBC Vectorworks 2011 |
VectorScript Declaration:
FUNCTION DBObjSQLSetRead
( hObject :HANDLE; SQLSentence :DYNARRAY[] of CHAR ) :BOOLEAN ; Python:
return BOOLEAN
def vs.DBObjSQLSetRead(hObject, SQLSentence): Description:
Set an object's SQL sentence for ODBC read.
| DBObjSQLSetWrite | ODBC Vectorworks 2011 |
VectorScript Declaration:
FUNCTION DBObjSQLSetWrite
( hObject :HANDLE; SQLSentence :DYNARRAY[] of CHAR ) :BOOLEAN ; Python:
return BOOLEAN
def vs.DBObjSQLSetWrite(hObject, SQLSentence): Description:
Set an object's SQL sentence for ODBC write.
| DBSetFormatConn | ODBC Vectorworks 2011 |
VectorScript Declaration:
FUNCTION DBSetFormatConn
( formatName :STRING; database :STRING; tableName :STRING ) :BOOLEAN ; Python:
return BOOLEAN
def vs.DBSetFormatConn(formatName, database, tableName): Description:
Set ODBC connection for the specified format.
| DBSetFormatFieldConn | ODBC Vectorworks 2011 |
VectorScript Declaration:
FUNCTION DBSetFormatFieldConn
( formatName :STRING; fieldName :STRING; columnName :STRING; linkType :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.DBSetFormatFieldConn(formatName, fieldName, columnName, linkType): Description:
Set ODBC connection for the specified format field.
| DBShowDBTableDlg | ODBC Vectorworks 2011 |
VectorScript Declaration:
FUNCTION DBShowDBTableDlg
( database :STRING; table :STRING ) :BOOLEAN ; Python:
return BOOLEAN
def vs.DBShowDBTableDlg(database, table): Description:
Show the specified database table dialog.
| DBShowManageDBsDlg | ODBC Vectorworks 2011 |
VectorScript Declaration:
PROCEDURE DBShowManageDBsDlg
; Python:
return None
def vs.DBShowManageDBsDlg(): Description:
Show the database manager dialog.
| DBShowObjConnDlg | ODBC Vectorworks 2011 |
VectorScript Declaration:
FUNCTION DBShowObjConnDlg
:BOOLEAN ; Python:
return BOOLEAN
def vs.DBShowObjConnDlg(): Description:
Show the object connection dialog for the selected objects.
| DBSQLExecute | ODBC Vectorworks 2011 |
VectorScript Declaration:
FUNCTION DBSQLExecute
( database :STRING; SQLQuery :DYNARRAY[] of CHAR; VAR outColumnCnt :LONGINT; VAR outResultSetInst :LONGINT ) :BOOLEAN ; Python:
return (BOOLEAN, outColumnCnt, outResultSetInst)
def vs.DBSQLExecute(database, SQLQuery): Description:
Executes a SQL in the specified database connected to the current document. Note! The resultSetInstance have to be deleted with call to 'DBSQLExecuteDelete'
| DBSQLExecuteDelete | ODBC Vectorworks 2011 |
VectorScript Declaration:
PROCEDURE DBSQLExecuteDelete
( VAR resultSetInst:LONGINT ) ; Python:
return resultSetInst
def vs.DBSQLExecuteDelete(): Description:
Deletes a resultSetInstance created with 'DBSQLExecute' or 'DBSQLExecuteDSN'
| DBSQLExecuteDSN | ODBC Vectorworks 2011 |
VectorScript Declaration:
FUNCTION DBSQLExecuteDSN
( dsn :DYNARRAY[] of CHAR; userName :DYNARRAY[] of CHAR; password :DYNARRAY[] of CHAR; SQLQuery :DYNARRAY[] of CHAR; VAR outColumnCnt :LONGINT; VAR outResultSetInst :LONGINT ) :BOOLEAN ; Python:
return (BOOLEAN, outColumnCnt, outResultSetInst)
def vs.DBSQLExecuteDSN(dsn, userName, password, SQLQuery): Description:
Executes a SQL in the specified DSN registered in the ODBC manager. Note! The resultSetInstance have to be deleted with call to 'DBSQLExecuteDelete'
| DBSQLExecuteError | ODBC Vectorworks 2012 |
VectorScript Declaration:
FUNCTION DBSQLExecuteError
( VAR message :DYNARRAY[] of CHAR; VAR state :DYNARRAY[] of CHAR; VAR code :LONGINT; VAR internalDesc :DYNARRAY[] of CHAR ) :BOOLEAN ; Python:
return (BOOLEAN, message, state, code, internalDesc)
def vs.DBSQLExecuteError(): Description:
Return information about the last error occured in the ODBC API functions.
| DBSQLExecuteGet | ODBC Vectorworks 2011 |
VectorScript Declaration:
FUNCTION DBSQLExecuteGet
( resultSetInst :LONGINT; colIndex :LONGINT; VAR outColumnName :DYNARRAY[] of CHAR; VAR outValue :DYNARRAY[] of CHAR ) :BOOLEAN ; Python:
return (BOOLEAN, outColumnName, outValue)
def vs.DBSQLExecuteGet(resultSetInst, colIndex): Description:
Retrieves information from the resultSetInstance created with 'DBSQLExecute' or 'DBSQLExecuteDSN'
| DBSQLExecuteNext | ODBC Vectorworks 2011 |
VectorScript Declaration:
FUNCTION DBSQLExecuteNext
( resultSetInst:LONGINT ) :BOOLEAN ; Python:
return BOOLEAN
def vs.DBSQLExecuteNext(resultSetInst): Description:
Moves the resultSet current pointer to the next entry.