IDLitUI::RegisterUIService

IDL Reference Guide: iTools Object Classes

IDLitUI::RegisterUIService

Syntax | Return Value | Arguments | Keywords | Version History

The IDLitUI::RegisterUIService function method registers a user interface service with the user interface. Once the user interface service has been registered, the iTool with which the user interface is associated can call the UI service to display dialogs or other UI elements.

Note
Every UI service must implement a callback function that displays the requested user interface. See Creating a User Interface Service for details.

Syntax

Restult = Obj->[IDLitUI::]RegisterUIService(Name, Callback)

Return Value

Returns an iTool object identifier for the UI service specified by Name.

Arguments

Name

A string containing the human readable name of the user interface being registered.

Callback

A string containing the name of the callback function for this UI service. The callback function is called when execution of the UI service is requested. The callback should have the following calling signature:

FUNCTION NAME, oUI, oTarget

where:

NAME is the name of the callback function,

oUI is an object reference to the user interface object of which the UI service is a part

oTarget is an object reference to the object that is the target of the operation or action with which the UI service is associated.

Keywords

None

Version History


6.0	Introduced

IDL Online Help (March 06, 2007)