XmbLookupString(3X11) XmbLookupString(3X11) NAME XmbLookupString, XwcLookupString, Xutf8LookupString - obtain composed input from an input method SYNTAX int XmbLookupString(XIC ic, XKeyPressedEvent *event, char *buffer_return, int bytes_buffer, KeySym *keysym_return, Status *status_return); int XwcLookupString(XIC ic, XKeyPressedEvent *event, wchar_t *buffer_return, int wchars_buffer, KeySym *keysym_return, Status *status_return); int Xutf8LookupString(XIC ic, XKeyPressedEvent *event, char *buffer_return, int bytes_buffer, KeySym *keysym_return, Status *status_return); ARGUMENTS buffer_return Returns a multibyte string(3,n) or wide character string(3,n) (if(3,n) any) from the input method. bytes_buffer wchars_buffer Specifies space available in(1,8) the return buffer. event Specifies the key event to be used. ic Specifies the input context. keysym_return Returns the KeySym computed from the event if(3,n) this argument is not NULL. status_return Returns a value indicating what kind of data is returned. DESCRIPTION The XmbLookupString, XwcLookupString and Xutf8LookupString functions return the string(3,n) from the input method specified in(1,8) the buffer_return argument. If no string(3,n) is returned, the buffer_return argument is unchanged. The KeySym into which the KeyCode from the event was mapped is returned in(1,8) the keysym_return argument if(3,n) it is non-NULL and the status_return argument indicates that a KeySym was returned. If both a string(3,n) and a KeySym are returned, the KeySym value does not necessarily correspond to the string(3,n) returned. XmbLookupString and Xutf8LookupString return the length of the string(3,n) in(1,8) bytes, and XwcLookupString returns the length of the string(3,n) in(1,8) char- acters. Both XmbLookupString and XwcLookupString return text in(1,8) the encoding(3,n) of the locale(3,5,7) bound to the input method of the specified input context, and Xutf8LookupString returns text in(1,8) UTF-8 encoding. Each string(3,n) returned by XmbLookupString and XwcLookupString begins in(1,8) the initial state of the encoding(3,n) of the locale(3,5,7) (if(3,n) the encoding(3,n) of the locale(3,5,7) is state-dependent). Note To ensure proper input processing, it is essential that the client pass only KeyPress events to XmbLookupString, XwcLookupString and Xutf8LookupString. 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 three functions each return a value to sta- tus_return that indicates what has been returned in(1,8) the other argu- ments. The possible values returned are: XBufferOverflow The input string(3,n) to be returned is too large for the supplied buffer_return. The required size (for XmbLookupString, Xutf8LookupString in(1,8) bytes; for XwcLookup- String in(1,8) characters) is returned as the value of the function, and the contents 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 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(1,8) the buffer_return argu- ment, using the encoding(3,n) described above, and the string(3,n) length is returned as the value of the function. The content of the keysym_return argument is not modified. XLookupKeySym A KeySym has been returned instead of a string(3,n) and is returned in(1,8) keysym_return. The content of the buffer_return argument is not modified, and the function returns zero. XLookupBoth Both a KeySym and a string(3,n) are returned; XLookupChars and XLookupKeySym occur simul- taneously. It does not make any difference if(3,n) the input context passed as an argu- ment to XmbLookupString, XwcLookupString and Xutf8LookupString is the one currently in(1,8) 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, XwcLookupString or Xutf8LookupString even though it does not have any more keyboard focus. The function Xutf8LookupString is an extension introduced by The XFree86 Project, Inc. in(1,8) their 4.0.2 release. Its presence is indicated by the macro X_HAVE_UTF8_STRING. SEE ALSO XLookupKeysym(3X11) Xlib - C Language X Interface XLIB FUNCTIONS __xorgversion__ XmbLookupString(3X11)