tcomIDomains Interface Reference

Collection of domains. More...

List of all members.

Public Member Functions
HRESULT	Item ([in] VARIANT *index,[out, retval] VARIANT *pvaItem)
	Return specific domain.
HRESULT	SelectDomain ([in] long parentWnd,[out, retval] VARIANT *pvaItem)
	Select domain.
HRESULT	_NewEnum ([out, retval] IUnknown **ppEnum)
	Enumerator for domain objects.
Properties
VARIANT	Count [get]
	Return number of domains.

---

Detailed Description

Collection of domains.

Object can be used to get specific domain or to enumerate all domains.

Following code will iterate all available domains:

 set tahiti=CreateObject("LightComp.Tahiti")
 set domains = tahiti.domains
 For Each domain In domains
  ' do something here
 Next

---

Member Function Documentation

HRESULT _NewEnum

(

[out, retval] IUnknown **

ppEnum

)

Enumerator for domain objects.

Enumerator is IEnumVARIANT. All enumerated objects have type of tcomIDomain.

Note:

This method is used in Visual Basic in "For Each .. In ... Next" statement.

HRESULT Item	(	[in] VARIANT *	index,
		[out, retval] VARIANT *	pvaItem
	)

Return specific domain.

Return tcomIDomain object.

Parameters:

index

This can be domain index (0...count-1) or domain name. Index have to be integer, domain name have to be string.

Return values:

pvaItem

Return domain object if available (tcomIDomain). Return error if domain with given index does not exists or domain was not found.

HRESULT SelectDomain	(	[in] long	parentWnd,
		[out, retval] VARIANT *	pvaItem
	)

Select domain.

Function display domain selection dialog and allows to select domain. Return tcomIDomain object.

Return values:

pvaItem

Return domain object if available (tcomIDomain). Return E_ABORTED (0x80004004L) if canceled.

---

Property Documentation

VARIANT Count [get]

Return number of domains.

Return number of all domains including active, inactive and hidden domains.

Returns:

Return number of domains.