<!-- $XConsortium: ImGetXIM.sgm /main/8 1996/09/08 20:47:41 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->

<RefEntry Id="CDEMMA.MAN266.rsml.1">
<RefMeta>
<RefEntryTitle>XmImGetXIM</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmImGetXIM</Function></RefName>
<RefPurpose>An input manager function that retrieves the input
method associated with a specified widget
<IndexTerm>
<Primary>XmImGetXIM</Primary>
</IndexTerm><IndexTerm>
<Primary>input manager functions</Primary>
<Secondary>XmImGetXIM</Secondary>
</IndexTerm></RefPurpose>
</RefNameDiv>
<!---->
<!-- @OSF_COPYRIGHT@-->
<!-- COPYRIGHT NOTICE-->
<!-- Copyright (c) 1990, 1991, 1992, 1993 Open Software Foundation, Inc.-->
<!-- ALL RIGHTS RESERVED (MOTIF). See the file named COPY.MOTIF.DOC for-->
<!-- the full copyright text.-->
<!---->
<!-- HISTORY-->
<!---->
<!-- **-->
<!-- **-->
<!-- **  (c) Copyright 1989, 1990 by Open Software Foundation, Inc.-->
<!-- **      All Rights Reserved.-->
<!-- **-->
<!-- **  (c) Copyright 1987, 1988, 1989, by Hewlett-Packard Company-->
<!-- **-->
<!-- **  (c) Copyright 1987, 1988 by Digital Equipment Corporation,-->
<!-- **      Maynard, MA.  All Rights Reserved.-->
<!-- **-->
<!-- **-->
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Xm/XmIm.h>
</FuncSynopsisInfo>
<FuncDef>XIM <Function>XmImGetXIM</Function></FuncDef>
<!--<ParamDef>widget<ParamDef>-->
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmImGetXIM</Function> retrieves the XIM data structure representing
the input method that the input manager has opened for the
specified widget. If an input method has not been opened
by a previous call to <Function>XmImRegister</Function>, the first time this
routine is called it opens an input method using the
<SystemItem Class="Resource">XmNinputMethod</SystemItem> resource for the VendorShell. If the
<SystemItem Class="Resource">XmNinputMethod</SystemItem> is NULL, an input method is opened using the
current locale.
If it cannot open an input method, the
function returns NULL.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">widget</Symbol></Term>
<ListItem>
<Para>Specifies the ID of a widget registered with the input manager
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>Returns the input method for the current locale associated with
the specified widget's input manager; otherwise, returns NULL.
The application is responsible for freeing the returned XIM by calling
<Function>XmImCloseXIM</Function>.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmImCloseXIM;,
&cdeman.XmImGetXIM;,
&cdeman.XmImMbLookupString;, and
&cdeman.XmImRegister;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
