_XONDAO2_WorkSpace_VIs.vi

Description

A Workspace object defines a named session for a user. It contains open databases and provides mechanisms for simultaneous transactions and, in Microsoft Jet workspaces, secure workgroup support. It also controls whether you are going through the Microsoft Jet database engine or ODBCDirect to access external data. Remarks A Workspace is a non-persistent object that defines how your application interacts with data — either by using the Microsoft Jet database engine or ODBCDirect. Use the Workspace object to manage the current session or to start an additional session. In a session, you can open multiple databases or connections and manage transactions. For example, you can:

Further, using a Microsoft Jet database, you can establish security based on user names and passwords: When you first refer to or use a Workspace object, you automatically create the default workspace, DBEngine.Workspaces(0). The settings of the Name and UserName properties of the default workspace are "#Default Workspace#" and "Admin," respectively. If security is enabled, the UserName property setting is the name of the user who logged on. To establish an ODBCDirect Workspace object, and thereby avoid loading the Microsoft Jet database engine into memory, set the DBEngine object's DefaultType property to dbUseODBC, or set the type argument of the CreateWorkspace method to dbUseODBC. When you use transactions, all databases in the specified Workspace are affected — even if multiple Database objects are opened in the Workspace. For example, you use a BeginTrans method, update several records in a database, and then delete records in another database. If you then use the Rollback method, both the update and delete operations are canceled and rolled back. You can create additional Workspace objects to manage transactions independently across Database objects. You can create Workspace objects with the CreateWorkspace method. After you create a new Workspace object, you must append it to the Workspaces collection if you need to refer to it from the Workspaces collection. You can use a newly created Workspace object without appending it to the Workspaces collection. However, you must refer to it by the object variable to which you have assigned it. To refer to a Workspace object in a collection by its ordinal number or by its Name property setting, use either of the following syntax forms: Workspaces[0] Workspaces["name"]

WSAppend

This function appends a new workspace to the collection of active workspaces used.

Parameters

WSHandle in - Workspace Handle (Input)

WSHandle out - Workspace Handle (Output)

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

XOn Software GmbH

Connector Pane

WSAppend

Controls and Indicators

cdlrn

 WSHandle in

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

idlrn

 WSHandle out

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSBeginTrans

Call this function to initiate a transaction. After you call BeginTrans, updates you make to your data or database structure take effect when you commit the transaction. Because the workspace defines a single transaction space, the transaction applies to all open databases in the workspace. There are two ways to complete the transaction:

•Call the CommitTrans function to commit the transaction and save changes to the data source.

•Or call the Rollback function to cancel the transaction.

Closing the workspace or a database while a transaction is pending rolls back all pending transactions.

If you need to isolate transactions on one ODBC data source from those on another ODBC data source, see the SetIsolateODBCTrans function.

Parameters

WSHandle in - Workspace Handle (Input)

WSHandle out - Workspace Handle (Output)

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

XOn Software GmbH

Connector Pane

WSBeginTrans

Controls and Indicators

cdlrn

 WSHandle In

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ii32

 FResult

idlrn

 WSHandle Out

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSClose

Call this member function to close the workspace. Closing an open workspace releases the underlying DAO object and, if the workspace is a member of the Workspaces collection, removes it from the collection. Calling Close is good programming practice.

Caution Closing a workspace closes any open databases in the workspace. This results in any recordsets open in the databases being closed as well, and any pending edits or updates are rolled back.

Workspace objects are not permanent; they only exist while references to them exist. This means that when the database engine session ends, the workspace and its Databases collection do not persist. You must re-create them for the next session by opening your workspace and database(s) again.

Parameters

WSHandle in - Workspace Handle (Input)

WSHandle out - Workspace Handle (Output)

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

XOn Software GmbH

Connector Pane

WSClose

Controls and Indicators

cdlrn

 WSHandle In

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ii32

 FResult

idlrn

 WSHandle Out

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSCommitTrans

Call this function to commit a transaction (save a group of edits and updates to one or more databases in the workspace). A transaction consists of a series of changes to the database's data or its structure, beginning with a call to BeginTrans. When you complete the transaction, either commit it or roll it back (cancel the changes) with Rollback. By default, without transactions, updates to records are committed immediately. Calling BeginTrans causes commitment of updates to be delayed until you call CommitTrans.

Caution Within one workspace, transactions are always global to the workspace and are not limited to only one database or recordset. If you perform operations on more than one database or recordset within a workspace transaction, CommitTrans commits all pending updates, and Rollback restores all operations on those databases and recordsets.

When you close a database or workspace with pending transactions, the transactions are all rolled back.

Note This is not a two-phase commit mechanism. If one update fails to commit, others still will commit.

Parameters

WSHandle in - Workspace Handle (Input)

WSHandle out - Workspace Handle (Output)

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

XOn Software GmbH

Connector Pane

WSCommitTrans

Controls and Indicators

cdlrn

 WSHandle In

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ii32

 FResult

idlrn

 WSHandle Out

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSCompactDatabase

Call this function to compact a specified Microsoft Jet (.MDB) database. As you change data in a database, the database file can become fragmented and use more disk space than necessary. Periodically, you should compact your database to defragment the database file. The compacted database is usually smaller. You can also choose to change the collating order, the encryption, or the version of the data format while you copy and compact the database.

Warning The CompactDatabase function will not correctly convert a complete Microsoft Access database from one version to another. Only the data format is converted. Microsoft Access-defined objects, such as forms and reports, are not converted. However, the data is correctly converted.

Tip You can also use CompactDatabase to copy a database file.

Parameters

WSHandle in - Workspace Handle (Input)

SrcName - The name of an existing, closed database. It can be a full path and filename, such as "C:\MYDB.MDB". If the filename has an extension, you must specify it. If your network supports the uniform naming convention (UNC), you can also specify a network path, such as "\\MYSERVER\MYSHARE\MYDIR\MYDB.MDB".

DestName - The full path of the compacted database that you are creating. You can also specify a network path as with SrcName. You cannot use the DestName argument to specify the same database file as SrcName.

LpszPassword - A password, used when you want to compact a password-protected database.

Note that if you use the version of CompactDatabase that takes a password, you must supply all parameters.

Lang - A enum expression used to specify collating order for creating DestName. If you

omit this argument by accepting the default value of General, the locale of the

new database is the same as that of the old database. Possible values are:

Options - Indicates one or more options for the target database, DestName. If you omit this

argument by accepting the default value, the DestName will have the same

encryption and the same version as lpszSrcName. Possible values, which specify

a database format, not a database engine version, are:

2 Encrypt the database while compacting.

4 Decrypt the database while compacting.

1 Create a database that uses the Microsoft Jet database engine version 1.0 while compacting.

8 Create a database that uses the Microsoft Jet database engine version 1.1 while compacting.

16 Create a database that uses the Microsoft Jet database engine version 2.0 while compacting.

32 Create a database that uses the Microsoft Jet database engine version 3.0 while compacting.

WSHandle out Workspace Handle (Output)

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

XOn Software GmbH

Connector Pane

WSCompactDatabase

Controls and Indicators

cdlrn

 WSHandle In

cstr

 SrcName

cstr

 DestName

cenum

 Lang(NoChg)

ci32

 Options(NoChg)

cstr

 Password

c1di32

 XLLang

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ii32

 FResult

idlrn

 WSHandle Out

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSCreate

Call this member function to create a new DAO workspace object. The overall creation process is:

1.Construct a Workspace object.

2.Call the Create function to create the underlying DAO workspace. You must specify a workspace name.

3.Optionally call Append if you want to add the workspace to the database engine's Workspaces

collection. You can work with the workspace without appending it.

After the Create call, the workspace object is in an open state, ready for use. You do not call Open after Create. You do not call Create if the workspace already exists in the Workspaces collection. Create initializes the database engine if it has not already been initialized for your application.

Parameters

WSHandle in - Workspace Handle (Input)

lpszName - A string with up to 14 characters that uniquely names the new workspace object. You must supply a name.

UserName - The user name of the workspace's owner. For requirements, see theDefaultUser parameter to the SetDefaultUser function.

Password - The password for the new workspace object. A password can be up to 14 characters long and can contain any character except ASCII 0 (null). Passwords are case-sensitive.

WSHandle out - Workspace Handle (Output)

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

XOn Software GmbH

Connector Pane

WSCreate

Controls and Indicators

cdlrn

 WSHandle In

cstr

 Name

cstr

 UserName(admin)

cstr

 Password("")

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ii32

 FResult

idlrn

 WSHandle Out

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSDeleteWS

This is the destructor of the Workspace Handle

Parameters

WSHandle in - Workspace Handle (Input)

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

XOn Software GmbH

Connector Pane

WSDeleteWS

Controls and Indicators

cdlrn

 WSHandle

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSGetDatabaseCount

Call this function to retrieve the number of DAO database objects in the workspace's Databases collection (the number of open databases in the workspace). GetDatabaseCount is useful if you need to loop through all defined databases in the workspace's Databases collection. To obtain information about a given database in the collection, see GetDatabaseInfoByIndex. Typical usage is to call GetDatabaseCount for the number of open databases, then use that number as a loop index for repeated calls to GetDatabaseInfoByIndex.

Parameters

WSHandle in - Workspace Handle (Input)

WSHandle out - Workspace Handle (Output)

Result - The number of open databases in the workspace.

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

XOn Software GmbH

Connector Pane

WSGetDatabaseCount

Controls and Indicators

cdlrn

 WSHandle In

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ii32

 Result

idlrn

 WSHandle Out

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSGetDatabaseInfoByIndex

Call this function to obtain various kinds of information about a database open in the workspace.

Parameters

WSHandle in - Workspace Handle (Input)

Index - The zero-based index of the database object in the workspace's Databases collection

WSHandle out - Workspace Handle (Output)

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

DatabaseInfo - A cluster that returns the information requested

XOn Software GmbH

Connector Pane

WSGetDatabaseInfoByIndex

Controls and Indicators

cdlrn

 WSHandle in

ci32

 Index(0)

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

idlrn

 WSHandle out

iclst

 DatabaseInfo

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSGetDatabaseInfoByName

Call this function to obtain various kinds of information about a database open in the workspace.

Parameters

Name - The name of the database object

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

DatabaseInfo - A cluster that returns the information requested

internal: WSHandle in - Workspace Handle (Input)

internal: WSHandle out - Workspace Handle (Output)

XOn Software GmbH

Connector Pane

WSGetDatabaseInfoByName

Controls and Indicators

cdlrn

 WSHandle in

cstr

 Name

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

idlrn

 WSHandle out

iclst

 DatabaseInfo

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSGetIniPath

Call this function to obtain the location of the Microsoft Jet database engine's initialization settings in the Windows registry. You can use the location to obtain information about settings for the database engine. The information returned is actually the name of a registry subkey.

Parameters

WSHandle in - Workspace Handle (Input)

WSHandle out - Workspace Handle (Output)

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

IniPath - A String containing the registry location.

XOn Software GmbH

Connector Pane

WSGetIniPath

Controls and Indicators

cdlrn

 WSHandle In

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ci32

 Length

ii32

 FResult

idlrn

 WSHandle Out

istr

 INIPath

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSGetIsolateODBCTrans

Call this function to get the current value of the DAO IsolateODBCTrans property for the workspace. In some situations, you might need to have multiple simultaneous transactions pending on the same ODBC database. To do this, you need to open a separate workspace for each transaction. Keep in mind that although each workspace can have its own ODBC connection to the database, this slows system performance. Because transaction isolation is not normally required, ODBC connections from multiple workspace objects opened by the same user are shared by default.

Some ODBC servers, such as Microsoft SQL Server, do not allow simultaneous transactions on a single connection. If you need to have more than one transaction at a time pending against such a database, set the IsolateODBCTrans property to TRUE on each workspace as soon as you open it. This forces a separate ODBC connection for each workspace.

Parameters

WSHandle in - Workspace Handle (Input)

WSHandle out - Workspace Handle (Output)

Result - TRUE if ODBC transactions are isolated; otherwise FALSE.

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

XOn Software GmbH

Connector Pane

WSGetIsolateODBCTrans

Controls and Indicators

cdlrn

 WSHandle In

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ibool

 Result

idlrn

 WSHandle Out

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSGetLoginTimeout

Call this function to get the current value of the DAO LoginTimeout property for the workspace. This value represents the number of seconds before an error occurs when you attempt to log in to an ODBC database. The default LoginTimeout setting is 20 seconds. When LoginTimeout is set to 0, no timeout occurs and the communication with the data source might hang.

When you are attempting to log in to an ODBC database, such as Microsoft SQL Server, the connection may fail as a result of network errors or because the server is not running. Rather than waiting for the default 20 seconds to connect, you can specify how long the database engine waits before it produces an error. Logging in to the server happens implicitly as part of a number of different events, such as running a query on an external server database.

Parameters

WSHandle in Workspace Handle (Input)

WSHandle out Workspace Handle (Output)

Result The number of seconds before an error occurs when you attempt to log in to an

ODBC database.

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

XOn Software GmbH

Connector Pane

WSGetLoginTimeout

Controls and Indicators

cdlrn

 WSHandle In

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ii32

 Result

idlrn

 WSHandle Out

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSGetName

Call this member function to get the user-defined name of the workspace object. The name is useful for accessing the DAO workspace object in the database engine's Workspaces collection by name.

Parameters

WSHandle in - Workspace Handle (Input)

WSHandle out - Workspace Handle (Output)

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

Name - A String containing the user-defined name of the DAO workspace.

XOn Software GmbH

Connector Pane

WSGetName

Controls and Indicators

cdlrn

 WSHandle In

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ci32

 Length

ii32

 FResult

idlrn

 WSHandle Out

istr

 Name

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSGetSystemDB

Gets the path for the current location of the system database file.

Parameters:

WSHandle In - Handle of the Workspace

WSHandle Out - Handle of the Workspace

SystemDB - Name of the new System Database

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

XOn Software GmbH

Connector Pane

WSGetSystemDB

Controls and Indicators

cdlrn

 WSHandle In

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ii32

 FResult

idlrn

 WSHandle Out

istr

 SystemDB

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSGetUserName

Call this function to obtain the name of the owner of the workspace.

To get or set the permissions for the workspace owner, call DAO directly to check the Permissions property setting; this determines what permissions that user has. To work with permissions, you need a SYSTEM.MDA file.

Parameters

WSHandle in - Workspace Handle (Input)

WSHandle out - Workspace Handle (Output)

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

UserName - A String that represents the owner of the workspace.

XOn Software GmbH

Connector Pane

WSGetUserName

Controls and Indicators

cdlrn

 WSHandle In

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ci32

 Length

ii32

 Result

idlrn

 WSHandle Out

istr

 UserName

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSGetVersion

Call this function to determine the version of the Microsoft Jet database engine in use. The value returned represents the version number in the form "major.minor"; for example, "3.0". The product version number (for example, 3.0) consists of the version number (3), a period, and the release number (0).

Parameters

WSHandle in - Workspace Handle (Input)

WSHandle out - Workspace Handle (Output)

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

Version - A String that indicates the version of the database engine

XOn Software GmbH

Connector Pane

WSGetVersion

Controls and Indicators

cdlrn

 WSHandle In

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ci32

 Length

ii32

 FResult

idlrn

 WSHandle Out

istr

 WSVersion

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSGetWorkspaceCount

Call this function to retrieve the number of DAO database objects in the workspace's Databases collection (the number of open databases in the workspace). GetDatabaseCount is useful if you need to loop through all defined databases in the workspace's Databases collection. To obtain information about a given database in the collection, see GetDatabaseInfo. Typical usage is to call GetDatabaseCount for the number of open databases, then use that number as a loop index for repeated calls to GetDatabaseInfo.

Parameters

WSHandle in - Workspace Handle (Input)

WSHandle out - Workspace Handle (Output)

WSCount - The number of open workspaces in the Workspaces collection.

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

XOn Software GmbH

Connector Pane

WSGetWorkspaceCount

Controls and Indicators

cdlrn

 WSHandle In

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ii32

 WSCount

idlrn

 WSHandle Out

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSGetWorkspaceInfoByIndex

Call this function to obtain various kinds of information about a workspace open in the session.

Parameters

WSHandle in - Workspace Handle (Input)

Index - The zero-based index of the database object in the Workspaces collection

WSHandle out - Workspace Handle (Output)

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

WorkspaceInfo - A cluster that returns the information requested.

XOn Software GmbH

Connector Pane

WSGetWorkspaceInfoByIndex

Controls and Indicators

cdlrn

 WSHandle in

ci32

 Index(0)

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

idlrn

 WSHandle out

iclst

 WorkspaceInfo

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSGetWorkspaceInfoByName

Call this function to obtain various kinds of information about a workspace open in the session.

Parameters

WSHandle in - Workspace Handle (Input)

Name - The name of the workspace. The name is a string with up to 14 characters that uniquely names the new workspace object.

WSHandle out - Workspace Handle (Output)

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

WorkspaceInfo - A cluster that returns the information requested.

XOn Software GmbH

Connector Pane

WSGetWorkspaceInfoByName

Controls and Indicators

cdlrn

 WSHandle in

cstr

 Name

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

idlrn

 WSHandle out

iclst

 WorkspaceInfo

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSIdle

Call Idle to provide the database engine with the opportunity to perform background tasks that may not be up-to-date because of intense data processing. This is often true in multiuser, multitasking environments in which there is not enough background processing time to keep all records in a recordset current.

Important Calling Idle is not necessary with databases created with version 3.0 of the Microsoft Jet database engine. Use Idle only for databases created with earlier versions.

This member function is not needed in single-user environments unless multiple instances of an application are running. The Idle member function may increase performance in a multiuser environment because it forces the database engine to flush data to disk, releasing locks on memory. You can also release read locks by making operations part of a transaction.

Parameters

WSHandle in Workspace Handle (Input)

Action - An -action to take during the idle processing. Currently the only valid action is FreeLocks.

WSHandle out - Workspace Handle (Output)

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

XOn Software GmbH

Connector Pane

WSIdle

Controls and Indicators

cdlrn

 WSHandle In

ci32

 Action(0)

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ii32

 FResult

idlrn

 WSHandle Out

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSIsOpen

Call this function to determine whether the Workspace object is open (that is, whether the object has been initialized by a call to Open or a call to Create). You can call any of the functions of a workspace that is in an open state.

Parameters

WSHandle in - Workspace Handle (Input)

WSHandle out - Workspace Handle (Output)

Result - TRUE if the workspace object is open; otherwise FALSE.

XOn Software GmbH

Connector Pane

WSIsOpen

Controls and Indicators

cdlrn

 WSHandle In

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ibool

 WSIsOpen

idlrn

 WSHandle Out

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSNewWs

This is the constructor of the Workspace Handle

Parameters

WSHandle out Workspace Handle (Output)

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

XOn Software GmbH

Connector Pane

WSNewWs

Controls and Indicators

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

idlrn

 WSHandle

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSOpen

After constructing a Workspace object, call this function to do one of the following:

•Explicitly open the default workspace. Pass ““ for Name

•Open an existing Workspace object, a member of the Workspaces collection, by name. Pass a valid name for an existing workspace object.

Open puts the workspace object into an open state and also initializes the database engine if it has not already been initialized for your application.

Parameters

WSHandle in - Workspace Handle (Input)

lpszName - The name of the DAO workspace to open (a string with up to 14 characters that uniquely names the workspace). Accept the default value ““ to explicitly open the default workspace.

WSHandle out - Workspace Handle (Output)

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

XOn Software GmbH

Connector Pane

WSOpen

Controls and Indicators

cdlrn

 WSHandle In

cstr

 Name(Def)

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

idlrn

 WSHandle Out

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSRepairDatabase

Call this function if you need to attempt to repair a corrupted database that accesses the Microsoft Jet database engine. You must close the database specified by „Name“ before you repair it. In a multiuser environment, other users cannot have „Name“ open while you are repairing it. If „Name“ is not closed or is not available for exclusive use, an error occurs.

This function attempts to repair a database that was marked as possibly corrupt by an incomplete write operation. This can occur if an application using the Microsoft Jet database engine is closed unexpectedly because of a power outage or computer hardware problem. If you complete the operation and call the Close member function or you quit the application in a usual way, the database will not be marked as possibly corrupt.

Note After repairing a database, it is also a good idea to compact it using the CompactDatabase function to defragment the file and to recover disk space.

Parameters

WSHandle in - Workspace Handle (Input)

Name - The path and filename for an existing Microsoft Jet engine database file. If you

omit the path, only the current directory is searched. If your system supports the

uniform naming convention (UNC), you can also specify a network path, such as:

"\\MYSERVER\MYSHARE\MYDIR\MYDB.MDB".

WSHandle out - Workspace Handle (Output)

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

XOn Software GmbH

Connector Pane

WSRepairDatabase

Controls and Indicators

cdlrn

 WSHandle In

cstr

 Name

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ii32

 FResult

idlrn

 WSHandle Out

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSRollback

Call this function to end the current transaction and restore all databases in the workspace to their condition before the transaction was begun.

Caution Within one workspace, transactions are always global to the workspace and are not limited to only one database or recordset. If you perform operations on more than one database or recordset within a workspace transaction, Rollback restores all operations on all of those databases and recordsets.

If you close a workspace without saving or rolling back any pending transactions, the transactions are automatically rolled back. If you call CommitTrans or Rollback without first calling BeginTrans, an error occurs.

Note When you begin a transaction, the database engine records its operations in a file kept in the directory specified by the TEMP environment variable on the workstation.

Parameters

WSHandle in - Workspace Handle (Input)

WSHandle out - Workspace Handle (Output)

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

XOn Software GmbH

Connector Pane

WSRollback

Controls and Indicators

cdlrn

 WSHandle In

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ii32

 FResult

idlrn

 WSHandle Out

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSSetDefaultPassword

Call this member function to set the default password that the database engine uses when a workspace object is created without a specific password. The default password that you set applies to new workspaces you create after the call. When you create subsequent workspaces, you do not need to specify a password in the Create call.

To use this member function:

1.Construct a Workspace but do not call Create.

2.Call SetDefaultPassword and, if you like, SetDefaultUser.

3.Call Create for this workspace or subsequent ones, without specifying a password.

By default, the DefaultUser is set to "admin" and the DefaultPassword is set to an empty string ("").

Parameters

WSHandle in - Workspace Handle (Input)

Password - The default password. A password can be up to 14 characters long and can contain any character except ASCII 0 (null). Passwords are case-sensitive.

WSHandle out - Workspace Handle (Output)

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

XOn Software GmbH

Connector Pane

WSSetDefaultPassword

Controls and Indicators

cdlrn

 WSHandle In

cstr

 Password

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

idlrn

 WSHandle Out

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ii32

 FResult

WSSetDefaultUser

Call this function to set the default user name that the database engine uses when a workspace is created without a specific user name. The default user name that you set applies to new workspaces you create after the call. When you create subsequent workspaces, you do not need to specify a user name in the Create call.

To use this member function:

1.Construct a Workspace but do not call Create.

2.Call SetDefaultUser and, if you like, SetDefaultPassword.

3.Call Create for this workspace or subsequent ones, without specifying a user name.

By default, the DefaultUser is set to "admin" and the DefaultPassword is set to an empty string ("").

Parameters

WSHandle in - Workspace Handle (Input)

User - The default user name. A user name can be 1 – 20 characters long and include alphabetic characters, accented characters, numbers, spaces, and symbols except for: " (quotation marks), / (forward slash), \ (backslash), [ ] (brackets), : (colon), | (pipe), < (less-than sign), > (greater-than sign), + (plus sign), = (equal sign), ; (semicolon), , ( comma), ? (question mark), * (asterisk), leading spaces, and control characters (ASCII 00 to ASCII 31)

WSHandle out - Workspace Handle (Output)

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

XOn Software GmbH

Connector Pane

WSSetDefaultUser

Controls and Indicators

cdlrn

 WSHandle In

cstr

 User

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

idlrn

 WSHandle Out

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSSetIniPath

Call this function to specify the location of Windows registry settings for the Microsoft Jet database engine. Call SetIniPath only if you need to specify special settings.

Important Call SetIniPath during application installation, not when the application runs. SetIniPath must be called before you open any workspaces, databases, or recordsets.

You can use this mechanism to configure the database engine with user-provided registry settings. The scope of this attribute is limited to your application and cannot be changed without restarting your application.

Parameters

WSHandle in - Workspace Handle (Input)

IniPath - A string containing the name of a Windows registry subkey for the location of Microsoft Jet database engine settings or parameters needed for installable ISAM databases.

WSHandle out - Workspace Handle (Output)

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

XOn Software GmbH

Connector Pane

WSSetIniPath

Controls and Indicators

cdlrn

 WSHandle In

cstr

 IniPath

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ii32

 FResult

idlrn

 WSHandle Out

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSSetIsolateODBCTrans

Call this member function to set the value of the DAO IsolateODBCTrans property for the workspace. In some situations, you might need to have multiple simultaneous transactions pending on the same ODBC database. To do this, you need to open a separate workspace for each transaction. Although each workspace can have its own ODBC connection to the database, this slows system performance. Because transaction isolation is not normally required, ODBC connections from multiple workspace objects opened by the same user are shared by default.

Some ODBC servers, such as Microsoft SQL Server, do not allow simultaneous transactions on a single connection. If you need to have more than one transaction at a time pending against such a database, set the IsolateODBCTrans property to TRUE on each workspace as soon as you open it. This forces a separate ODBC connection for each workspace.

Parameters

WSHandle in - Workspace Handle (Input)

IsolateODBCTrans - Pass TRUE if you want to begin isolating ODBC transactions. Pass FALSE if you want to stop isolating ODBC transactions.

WSHandle out - Workspace Handle (Output)

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

XOn Software GmbH

Connector Pane

WSSetIsolateODBCTrans

Controls and Indicators

cdlrn

 WSHandle In

cbool

 IsolateODBCTrans

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ii32

 Result

idlrn

 WSHandle Out

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSSetLoginTimeout

Call this member function to set the value of the DAO LoginTimeout property for the workspace. This value represents the number of seconds before an error occurs when you attempt to log in to an ODBC database. The default LoginTimeout setting is 20 seconds. When LoginTimeout is set to 0, no timeout occurs and the communication with the data source might hang.

When you are attempting to log in to an ODBC database, such as Microsoft SQL Server, the connection may fail as a result of network errors or because the server is not running. Rather than waiting for the default 20 seconds to connect, you can specify how long the database engine waits before it produces an error. Logging on to the server happens implicitly as part of a number of different events, such as running a query on an external server database. The timeout value is determined by the current setting of the LoginTimeout property.

Parameters

WSHandle in - Workspace Handle (Input)

Timeout - The number of seconds before an error occurs when you attempt to log in to an

ODBC database.

WSHandle out - Workspace Handle (Output)

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

XOn Software GmbH

Connector Pane

WSSetLoginTimeout

Controls and Indicators

cdlrn

 WSHandle In

ci32

 Timeout(sec)

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ii32

 FResult

idlrn

 WSHandle Out

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

WSSetSystemDB

Sets the path for the current location of the system database file.

Parameters:

WSHandle In - Handle of the Workspace

WSHandle Out - Handle of the Workspace

SystemDB - Name of the new System Database

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

XOn Software GmbH

Connector Pane

WSSetSystemDB

Controls and Indicators

cdlrn

 WSHandle In

cstr

 SystemDB

cclst

 error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ii32

 FResult

idlrn

 WSHandle Out

iclst

 error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.