ULConnection class

Represents a connection to an UltraLite.NET database.

Visual Basic syntax

Public NotInheritable Class ULConnection
    Inherits System.Data.Common.DbConnection

C# syntax

public sealed class ULConnection : System.Data.Common.DbConnection

Members

All members of ULConnection class, including all inherited members.

Name	Description
ULConnection constructor	Initializes a ULConnection object.
BeginDbTransaction method (Inherited from System.Data.Common.DbConnection)	Starts a database transaction.
BeginSynchronize method	UL Ext: Asynchronously launches a synchronization using the current the SyncParms object.
BeginTransaction method	Returns a transaction object.
CancelGetNotification method	UL Ext: Cancels any pending get-notification calls on all queues matching the given name.
CancelSynchronize method	UL Ext: Causes a running synchronization to be canceled at the next opportunity.
ChangeDatabase method	Changes the current database for an open connection.
ChangeEncryptionKey method	UL Ext: Changes the database's encryption key to the specified new key.
ChangePassword method	Changes the password for the user indicated in the connection string to the supplied new password.
Close method	Closes the database connection.
CountUploadRows method	UL Ext: Returns the number of rows that need to be uploaded when the next synchronization takes place.
CreateCommand method	Creates and initializes a ULCommand object associated with this connection and its current transaction.
CreateNotificationQueue method	UL Ext: Creates an event queue.
DeclareEvent method	UL Ext: Declares a named event.
DestroyNotificationQueue method	UL Ext: Destroys an event queue.
EndSynchronize method	UL Ext: Blocks until an asynchronously launched synchronization terminates.
EnlistTransaction method (Inherited from System.Data.Common.DbConnection)	Enlists in the specified transaction.
ExecuteTable method	UL Ext: Retrieves a database table in a ULTable object for direct manipulation.
GetLastDownloadTime method	UL Ext: Returns the time of the most recent download of the specified publication.
GetNewUUID method	UL Ext: Generates a new UUID (System.Guid).
GetNotification method	UL Ext: Blocks for a notification or timeout.
GetNotificationParameter method	UL Ext: Gets the value of a parameter for an event that was just read by the GetNotification method.
GetSchema method	Returns the list of supported schema collections.
GrantConnectTo method	UL Ext: Grants access to an UltraLite database for a user ID with a specified password.
OnStateChange method (Inherited from System.Data.Common.DbConnection)	Raises the System.Data.Common.DbConnection.StateChange event.
Open method	Opens a connection to a database using the previously-specified connection string.
RegisterForEvent method	UL Ext: Registers a queue to get events from an object.
ResetLastDownloadTime method	UL Ext: Resets the time of the most recent download.
RevokeConnectFrom method	UL Ext: Revokes access to an UltraLite database from the specified user ID.
RollbackPartialDownload method	UL Ext: Rolls back outstanding changes to the database from a partial download.
SendNotification method	UL Ext: Sends a notification to matching queues.
SetSyncListener method	Specifies the listener object used to process synchronization messages.
StartSynchronizationDelete method	UL Ext: Marks all subsequent deletes made by this connection for synchronization.
StopSynchronizationDelete method	UL Ext: Prevents delete operations from being synchronized.
Synchronize method	UL Ext: Synchronizes the database using the current ULConnection.SyncParms object.
TriggerEvent method	UL Ext: Triggers an event.
ValidateDatabase method	UL Ext: Performs validation on the current database.
ConnectionString property	Specifies the parameters to use for opening a connection to an UltraLite.NET database.
ConnectionTimeout property	This feature is not supported by UltraLite.NET.
Database property	Returns the name of the database to which the connection opens.
DatabaseID property	UL Ext: Specifies the Database ID value to be used for global autoincrement columns.
DataSource property	This feature is not supported by UltraLite.NET.
DbProviderFactory property (Inherited from System.Data.Common.DbConnection)	Gets the System.Data.Common.DbProviderFactory for this System.Data.Common.DbConnection.
GlobalAutoIncrementUsage property	UL Ext: Returns the percentage of available global autoincrement values that have been used.
LastIdentity property	UL Ext: Returns the most recent identity value used.
Schema property	UL Ext: Provides access to the schema of the current database associated with this connection.
ServerVersion property	This feature is not supported by UltraLite.NET.
State property	Returns the current state of the connection.
SyncParms property	UL Ext: Specifies the synchronization settings for this connection.
SyncResult property	UL Ext: Returns the results of the last synchronization for this connection.
InfoMessage event	Occurs when UltraLite.NET sends a warning or an informational message on this connection.
StateChange event	Occurs when this connection changes state.
INVALID_DATABASE_ID field	UL Ext: A database ID constant indicating that the ULConnection.DatabaseID property has not been set.
SYNC_ALL_DB field	Empty publication list, corresponding to the entire database.
SYNC_ALL_PUBS field	Publication name "*", corresponding to all publications.

Remarks

To use the UltraLite Engine runtime of UltraLite.NET, set the ULDatabaseManager.RuntimeType property to the appropriate value before using any other UltraLite.NET API.

A connection to an existing database is opened using the ULConnection.Open method.

You must open a connection before carrying out any other operation, and you must close the connection after you have finished all operations on the connection and before your application terminates. In addition, you must close all result sets and tables opened on a connection before closing the connection.

The schema of the database can be accessed using an open connection's ULConnection.Schema value.