The DatasetConfiguration object manages a local configuration containing a list of datasets available for a user to select. More...

Inheritance diagram for TRIM.SDK.DatasetConfiguration:

Public Member Functions
	DatasetConfiguration ()
	Constructs a DatasetConfiguration object. More...

DatabaseList	GetDatabases ()
	Destructor for the DatasetConfiguration. Cleans up any memory allocations associated with this configuration. Gets an array of Database objects that have been registered for use by the currently logged-in user More...

void	AddDatabase (Database dbToAdd)
	Adds a new TRIM database to the configuration. More...

void	RemoveDatabase (Database dbToRemove)
	Removes a database from the configuration. More...

void	SetDefaultDatabase (Database defaultDB)
	Sets the nominated database to be the default database in this configuration More...

void	Save ()
	Saves any changes made to this configuration. More...

Public Member Functions inherited from TRIM.SDK.TrimSDKObject
	TrimSDKObject ()

Static Public Member Functions
static DatabaseList	GetDatabases (string onWorkgroup, int onWorkgroupPort)
	Gets an array of Database objects that are currently supported by the nominated workgroup server. Note that Port Number 1137 is commonly reserved for a TRIM workgroup server More...

Properties
bool	OpenDefaultDatabase `[get, set]`
	Gets or sets a boolean parameter indicating if the user should automatically open the default database whenever running a client application. More...

Properties inherited from TRIM.SDK.TrimSDKObject
string	ErrorMessage `[get]`
	All TRIM SDK objects have an ErrorMessage property which can be used to examine any error that may have occurred in the most recent method call. More...

TrimException	Error `[get]`
	All TRIM SDK objects have an Error property which can be used to examine any error that may have occurred in the most recent method call. More...

Detailed Description

The DatasetConfiguration object manages a local configuration containing a list of datasets available for a user to select.

Constructor & Destructor Documentation

◆ DatasetConfiguration()

TRIM.SDK.DatasetConfiguration.DatasetConfiguration ( )

Constructs a DatasetConfiguration object.

Member Function Documentation

◆ AddDatabase()

void TRIM.SDK.DatasetConfiguration.AddDatabase ( Database dbToAdd )

Adds a new TRIM database to the configuration.

◆ GetDatabases() [1/2]

DatabaseList TRIM.SDK.DatasetConfiguration.GetDatabases ( )

Destructor for the DatasetConfiguration. Cleans up any memory allocations associated with this configuration. Gets an array of Database objects that have been registered for use by the currently logged-in user

◆ GetDatabases() [2/2]

static DatabaseList TRIM.SDK.DatasetConfiguration.GetDatabases	(	string	onWorkgroup,
		int	onWorkgroupPort
	)

static

Gets an array of Database objects that are currently supported by the nominated workgroup server. Note that Port Number 1137 is commonly reserved for a TRIM workgroup server

◆ RemoveDatabase()

void TRIM.SDK.DatasetConfiguration.RemoveDatabase ( Database dbToRemove )

Removes a database from the configuration.

◆ Save()

void TRIM.SDK.DatasetConfiguration.Save ( )

Saves any changes made to this configuration.

◆ SetDefaultDatabase()

void TRIM.SDK.DatasetConfiguration.SetDefaultDatabase ( Database defaultDB )

Sets the nominated database to be the default database in this configuration

Property Documentation

◆ OpenDefaultDatabase

bool TRIM.SDK.DatasetConfiguration.OpenDefaultDatabase

getset

Gets or sets a boolean parameter indicating if the user should automatically open the default database whenever running a client application.

Public Member Functions

Static Public Member Functions

Properties