IMAuxCreate Callback Subroutine

Purpose

Tells the application program to create an auxiliary area.

Syntax

int IMAuxCreate( IM AuxiliaryID UData)
IMObject IM;
caddr_t *AuxiliaryID;
caddr_t UData;

Description

The IMAuxCreate subroutine is invoked by the input method of the operating system to create an auxiliary area. The auxiliary area can contain several different forms of data and is not restricted by the interface.

Most input methods display one auxiliary area at a time, but callbacks must be capable of handling multiple auxiliary areas.

This subroutine is provided by applications that use input methods.

Parameters

Item Description
IM Indicates the input method instance.
AuxiliaryID Identifies the newly created auxiliary area.
UData Identifies an argument passed by the IMCreate subroutine.

Return Values

On successful return of the IMAuxCreate subroutine, a newly created auxiliary area is set to the AuxiliaryID value and the IMError global variable is returned. Otherwise, the IMNoError value is returned.