Legacy Document

Inside Macintosh: Text /

Chapter 7 - Text Services Manager / Text Services Manager Reference

Text Service Component Routines / Providing a Text Service

InitiateTextService

The InitiateTextService function instructs a specified text service component to do whatever it needs to set up its operations and commence its performance.

FUNCTION InitiateTextService (ts: ComponentInstance): 
                              ComponentResult;

ts

A component instance created by a prior call to the Component Manager OpenComponent function.

DESCRIPTION

The Text Services Manager can call InitiateTextService to any component that it has already opened with the Component Manager OpenComponent or OpenDefaultComponent functions. Text service components should be prepared to handle InitiateTextService calls at any time.

Any text service component can receive multiple InitiateTextService calls. The Text Services Manager calls InitiateTextService each time the user adds a text service to a TSM document, even if the text service component has already been opened. This provides an opportunity for the component to restart or to display user interface elements that the user may have closed.

This function should return a ComponentResult value of zero if there is no error, and an error code if there is one.