tcomIDomain Interface Reference

Domain. More...

List of all members.

Public Member Functions
HRESULT	Deactivate ()
	Deactivate domain.
HRESULT	Activate ([in] VARIANT *userName,[in] VARIANT *password,[in] VARIANT *mode,[out, retval] VARIANT *status)
	Activate domain.
HRESULT	Connect ([out, retval] VARIANT_BOOL *status)
Properties
IDispatch	Configuration [get]
	Domain configuration.
VARIANT	Status [get]
	Return domain status.
IDispatch	Components [get]
	Return collection of all domain specific components.
tcomIApplication	Application [get]
	Application.
IDispatch	MainFrame [get]
	Main domain frame.
VARIANT_BOOL	Connected [get]
	check connected status
BSTR	Name [get]
	Domain name.

---

Detailed Description

Domain.

Domain object provides access to the domain specific data and also to the user interface of the running Tahiti. It is important to check state of domain before accessing UI functions.

Domain can be in 1 of 3 states:

• 0 inactive - without UI - only some basic configuration is available
• 1 activating - domain is about to activate. User should wait till domain become inactive or activated
• 2 activated - domain is active with UI

---

Member Function Documentation

HRESULT Activate	(	[in] VARIANT *	userName,
		[in] VARIANT *	password,
		[in] VARIANT *	mode,
		[out, retval] VARIANT *	status
	)

Activate domain.

Parameters:

	userName	User name
	password	Password
	mode	Connection mode ONLINE domain will be connected to the server (authentication method can be passed as semicolon delimited optional parameter, example: ONLINE;external-token) OFFLINE domain will be in offline mode (without network communication)

Return values:

status

Return activation status 1 activating 2 activated When fail return string containing error message.

HRESULT Connect

(

[out, retval] VARIANT_BOOL *

status

)

Return values:

status

true when domain is connected to server, false otherwise

HRESULT Deactivate

(

)

Deactivate domain.

Deactivate domain and close all UI elements. Domain will be imidietly closed without asking user. Please be careful when to use this method. It better to let user save his work before deactivating domain. Look at the method Close in the tcomIFrame.

Domain can be later activated using method Activate.

---

Property Documentation

tcomIApplication Application [get]

Application.

This is main application object

IDispatch Components [get]

Return collection of all domain specific components.

It is possible to iterate over returned object. Returned object is tcomIComponents.

Return values:

pComponents

Return collection of components (tcomIComponents)

IDispatch Configuration [get]

Domain configuration.

Returned object is type of tcomIDomainConfiguration

Returns:

Return domain configuration object.

VARIANT_BOOL Connected [get]

check connected status

Return values:

status

true when domain is connected to server, false otherwise

IDispatch MainFrame [get]

Main domain frame.

Frame represents user interface for the domain.

Return values:

ppFrame

Return main frame for this domain. Returned object is type of tcomIFrame.

BSTR Name [get]

Domain name.

Return name of the domain

Returns:

Return domain name.

VARIANT Status [get]

Return domain status.

Read-only property

• 0 inactive
• 1 activating
• 2 activated