XmbLookupString(3X11)     XLIB FUNCTIONS    XmbLookupString(3X11)


NAME
       XmbLookupString, XwcLookupString - obtain composed input
       from an input method

SYNTAX
       int XmbLookupString(ic, event, bufferreturn,
       bytesbuffer, keysymreturn, statusreturn)
             XIC ic;
             XKeyPressedEvent *event;
             char *bufferreturn;
             int bytesbuffer;
             KeySym *keysymreturn;
             Status *statusreturn;

       int XwcLookupString(ic, event, bufferreturn,
       bytesbuffer, keysymreturn, statusreturn)
             XIC ic;
             XKeyPressedEvent *event;
             wchar_t *bufferreturn;
             int wcharsbuffer;
             KeySym *keysymreturn;
             Status *statusreturn;

ARGUMENTS
       bufferreturn
                 Returns a multibyte string or wide character
                 string (if any) from the input method.

       bytesbuffer
       wcharsbuffer
                 Specifies space available in return buffer.

       event     Specifies the key event to be used.

       ic        Specifies the input context.

       keysymreturn
                 Returns the KeySym computed from the event if
                 this argument is not NULL.

       statusreturn
                 Returns a value indicating what kind of data is
                 returned.

DESCRIPTION
       The XmbLookupString and XwcLookupString functions return
       the string from the input method specified in the
       buffer_return argument.  If no string is returned, the
       buffer_return argument is unchanged.

       The KeySym into which the KeyCode from the event was
       mapped is returned in the keysym_return argument if it is
       non-NULL and the status_return argument indicates that a
       KeySym was returned.  If both a string and a KeySym are



X Version 11                Release 5                           1

XmbLookupString(3X11)     XLIB FUNCTIONS    XmbLookupString(3X11)


       returned, the KeySym value does not necessarily correspond
       to the string returned.

       Note that XmbLookupString returns the length of the string
       in bytes and that XwcLookupString returns the length of
       the string in characters.

       XmbLookupString and XwcLookupString return text in the
       encoding of the locale bound to the input method of the
       specified input context.

       Note that each string returned by XmbLookupString and
       XwcLookupString begins in the initial state of the encod-
       ing of the locale (if the encoding of the locale is state-
       dependent).

                                  Note

            (R)In order to insure proper input processing,
            it is essential that the client pass only Key-
            Press events to XmbLookupString and
            XwcLookupString.  Their behavior when a client
            passes a KeyRelease event is undefined.


       Clients should check the status_return argument before
       using the other returned values.  These two functions both
       return a value to status_return that indicates what has
       been returned in the other arguments.  The possible values
       returned are:
       XBufferOverflow   The input string to be returned is too
                         large for the supplied buffer_return.  The
                         required size (XmbLookupString in bytes;
                         XwcLookupString in characters) is returned
                         as the value of the function, and the con-
                         tents of buffer_return and keysym_return
                         are not modified.  The client should recall
                         the function with the same event and a
                         buffer of adequate size in order to obtain
                         the string.
       XLookupNone       No consistent input has been composed so
                         far.  The contents of buffer_return and
                         keysym_return are not modified, and the
                         function returns zero.
       XLookupChars      Some input characters have been composed.
                         They are placed in the buffer_return argu-
                         ment, and the string length is returned as
                         the value of the function.  The string is
                         encoded in the locale bound to the input
                         context.  The contents of the keysym_return
                         argument is not modified.






X Version 11                Release 5                           2

XmbLookupString(3X11)     XLIB FUNCTIONS    XmbLookupString(3X11)


       XLookupKeySym     A KeySym has been returned instead of a
                         string and is returned in keysym_return.
                         The contents of the buffer_return argument
                         is not modified, and the function returns
                         zero.
       XLookupBoth       Both a KeySym and a string are returned;
                         XLookupChars and XLookupKeySym occur simul-
                         taneously.

       It does not make any difference if the input context
       passed as an argument to XmbLookupString and XwcLookup-
       String is the one currently in possession of the focus or
       not.  Input may have been composed within an input context
       before it lost the focus, and that input may be returned
       on subsequent calls to XmbLookupString or XwcLookupString,
       even though it does not have any more keyboard focus.

SEE ALSO
       XLookupKeysym(3X11)
       Xlib - C Language X Interface





































X Version 11                Release 5                           3