![]() |
InitiateTextService |
||||
Header: | TextServices.h | Carbon status: | Supported | |
Instructs a specified text service component to do whatever it needs to set up its operations and commence its performance.
ComponentResult InitiateTextService ( ComponentInstance ts );
A component instance created by a prior call to the Component Manager OpenComponent function.
This function should return a ComponentResult value of zero if there is no error, and an error code if there is one.
If you are writing a text service component, it must implement a function for this call.
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. The Text Services Manager makes this call either on its own or in response to application-interface calls it receives from client applications.
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.
Client applications also may make this call, but the Text Services Manager does not play a role in the connection between the client application making the call and the text service component receiving it. If you are an application making this call, you need to know the component instance of the component whose function you are calling.
Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.
© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)