NexusDB

 
Declaration

TnxBaseSession = class(TnxDataAccessStateComponent, IUnknown, InxSessionRequests)

 
Description

The mother of all sessions. It implements a component that is used the same way as Borland's TSession and adds some features unique to NexusDB.

 
Events

OnLogin

This event is triggered whenever the session is set to active and the connected server engine is in secure mode, thus requesting users to logon.

 
Methods

AddAlias

Adds a new alias. If an error occurs, it triggers an exception.

AddAliasEx

Adds a new alias and returns the error code.

CloseInactiveFolders

This method closes all folders of the session that were kept open by the server caching mechanism.

CloseInactiveTables

This method closes all tables of the session that were kept open by the server caching mechanism.

Create

constructor.

DeleteAlias

Deletes the given alias. Triggers an exception if it fails.

DeleteAliasEx

Deletes the given alias and returns the error code.

Destroy

destructor.

GetAliasNames

Fills the given list with all alias names.

GetAliasNamesEx

Fills the given list with all alias names and returns the error code.

GetAliasPath

Returns the path an alias points to. Remember that this is always a server relative path! The method triggers an exception if it fails.

GetAliasPathEx

Returns the path an alias points to. Remember that this is always a server relative path! It returns the error code as function result.

GetRegisteredClassList

The text for this method has been generated automatically. This means that it is not documented.

GetStoredProcNames

The text for this method has been generated automatically. This means that it is not documented.

GetStoredProcParams

The text for this method has been generated automatically. This means that it is not documented.

GetTableNames

Returns the tables of an alias in the given list.

IsAlias

Returns true if an alias with the given name exists, otherwise false.

IsConnected

This function returns true if the session is active/connected.

ModifyAlias

This function allows to change the name and/or path of an alias.

It triggers an exception if it fails.

ModifyAliasEx

This function allows to change the name and/or path of an alias and returns the error code.

 
Properties

BeepOnLoginError

If true, a Beep is triggered whenever a failed Login occurs.

DatabaseCount

Returns the number of tnxDatabase instances assigned to the session.

Databases

Returns the instance of tnxDatabase with index aInx in the list of assigned databases.

Password

The password for the session. It is only used when the connected Server Engine is in secure mode.

PasswordRetries

The number of retries for logon before the session returns a DBIERR_INVALIDUSRPASS error is triggered.

ServerEngine

Returns the Server Engine the session is connected to. Note, that this is read only in the base class. The Set method might be implemented in descendants.

ServerVersion

The text for this property has been generated automatically. This means that it is not documented.

Timeout

Sets the Timeout for the Session commands (in ms).

UserName

The user name for the session. It is only used when the connected Server Engine is in secure mode.

 
File

 
nxdb