Carbon


TerminateTextService

Header: TextServices.h Carbon status: Supported

Terminates the operations of a text service in preparation for closing the text service component.

ComponentResult TerminateTextService (
    ComponentInstance ts
);
Parameter descriptions
ts

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

function result

If the text service component needs to remain open, it should return an OSErr value in the component result return value. This could happen, for example, if the user chooses Cancel in response to a text service component dialog box.

If this call is made to the last open instance of a text service component, the component should hide any open palette windows. If it is an input method, the component should not dispose of its menu handle if it has a menu.

DISCUSSION

If you are writing a text service component, it must implement a function for this call.

The Text Services Manager calls TerminateTextService before closing the component instance. A text service component must use this opportunity to confirm any inline input in progress. The Text Services Manager makes this call either on its own or in response to application-interface calls it receives from client applications.

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.

AVAILABILITY

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)