c-treeDB API for C# - Developers Guide

CTSession Methods

Constructor / Destructor

• CTSession(): Creates a CTSession object.
• Dispose(): Destroys a CTSession object and resets all the dependent objects.

Session Handling

• Create(): Creates a new session dictionary.
• CreateSession(): Creates a new session dictionary.
• ClearPathPrefix(): Clear the previous path prefix.
• GetParam(): Returns the session parameter based on the parameter type.
• GetPath(): Retrieve the path (drive/directory) of the session dictionary.
• GetPathPrefix(): Retrieve the current session wide path prefix.
• GetServerName(): Returns the server name associated with the session.
• GetUserLogonName(): Returns the user name associated with the session.
• IsActive(): Checks if the session is active.
• Logon(): Logs on to c-tree Server, or c-tree instance, session.
• Logout(): Logs out from c-tree Server or from c-tree instance session and release all resources.
• SetParam(): Sets the session parameter values.
• SetPath(): Sets the session dictionary path.
• SetPathPrefix(): Sets the current session wide path prefix.
• GetLogonOnly(): Retrieves the session logon only flag.
• SetLogonOnly(): Sets the session logon only flag. This flag, when set to true before the session Logon, will prevent the session from using the session dictionary.
• GetSessionType(): Retrieves the current session type.
• SetSessionType(): Change the session type.

DataBase Handling

• AddDatabase(): Adds an existing database to the session.
• CreateDatabase(): Creates a new database.
• DeleteDatabase(): Drops a database from the session and deletes the data and index files.
• DisconnectAll(): Disconnects all databases.
• DropDatabase(): Drops a database from a session.
• FindDatabase(): Locates a database in a session.
• FirstDatabase(): Gets the first database for the session.
• GetDatabaseUID(): Retrieves a database UID.
• NextDatabase(): Gets the Next database for the session.
• GetDatabaseCount(): Retrieves the number of databases in the session dictionary.

Others

• GetLibType(): Retrieves the current library type.
• SetCurrentNodeName(): Sets a client side node name.

In This Section CTSession.CTSession CTSession.Dispose CTSession.AddDatabase CTSession.Attach CTSession.ClearPathPrefix CTSession.Create CTSession.CreateDatabase CTSession.CreateSession CTSession.DeleteDatabase CTSession.Detach CTSession.DisconnectAll CTSession.DropDatabase CTSession.FindDatabase CTSession.FirstDatabase CTSession.GetAttachMode CTSession.GetDatabaseCount CTSession.GetDatabaseUID CTSession.GetLibType CTSession.GetLogonOnly CTSession.GetParam CTSession.GetPath CTSession.GetPathPrefix CTSession.GetServerDateTime CTSession.GetServerName CTSession.GetSessionType CTSession.GetUserLogonName CTSession.IsActive CTSession.IsExclusive CTSession.Logon CTSession.Logout CTSession.NextDatabase CTSession.SetConfigurationFile CTSession.SetCurrentNodeName CTSession.SetExclusive CTSession.SetLogonOnly CTSession.SetParam CTSession.SetPath CTSession.SetPathPrefix CTSession.SetSessionType CTSession.StartDatabaseEngine CTSession.StopDatabaseEngine