tcomIApplication Interface Reference

Main application object. More...

List of all members.

Public Member Functions

HRESULT MsgBox ([in] tcomIFrame *pParentFrame,[in] long type,[in] BSTR message,[in] BSTR detail,[out, retval] VARIANT *pvaItem)
 Message Box.

Properties

BSTR Version [get]
 Return actual Tahiti version.
IDispatch Domains [get]
 Return collection of all available domains.
IDispatch Components [get]
 Return collection of all shared components.
IDispatch Configuration [get]
 Return shared configuration object.
IDispatch LoginDialog [get]
 Return login dialog.


Detailed Description

Main application object.

This object can be directly created as a COM object and provides access to the running Tahiti.

 set tahiti=CreateObject("LightComp.Tahiti")

Member Function Documentation

HRESULT MsgBox ( [in] tcomIFrame pParentFrame,
[in] long  type,
[in] BSTR  message,
[in] BSTR  detail,
[out, retval] VARIANT *  pvaItem 
)

Message Box.

Function display message box. This is simple modal dialog used to notify user about event or allows to ask question.

Parameters:
pParentFrame Parent frame. Parametr can be null.
type Dialog type
  • 0 - Error - red icon
  • 1 - Information
  • 2 - Warning - yellow icon
  • 3 - Question with answer yes/no
  • 4 - Question with answer yes/no/cancel
  • 5 - Question with answer ok/cancel
message Message to be display
detail Optional string to display more information. This field is usually used to display technical details.
Return values:
pvaItem Return integer representing result
  • 0 - OK
  • 1 - Cancel
  • 2 - Yes
  • 3 - No


Property Documentation

IDispatch Components [get]

Return collection of all shared components.

It is possible to iterate over returned object and browse all shared components. Returned object is tcomISharedComponents.

Returns:
Return collection of components (tcomISharedComponents)

IDispatch Configuration [get]

Return shared configuration object.

Returns:
Return shared configuration. Object type is tcomISharedConfiguration

IDispatch Domains [get]

Return collection of all available domains.

It is possible to iterate over returned object and browse all domains. Returned object is tcomIDomains.

Returns:
Return collection of domains (tcomIDomains)

IDispatch LoginDialog [get]

Return login dialog.

Returns:
Return login dialog. Object type is tcomILoginDialog

BSTR Version [get]

Return actual Tahiti version.

Returns:
Returned value is string in format X.Y.Z., e.g. "5.0.1"


Generated on Thu Aug 27 12:37:14 2009 for Tahiti COM API