home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / evbl0627.zip / everblue_20010627.zip / x11 / Xlib_FetchName.c < prev    next >
C/C++ Source or Header  |  2000-06-15  |  3KB  |  95 lines
  1. #include "Xlib.h"
  2. #include "Xlib_private.h" 
  3.  
  4. /*
  5.  
  6. Copyright 1986, 1998  The Open Group
  7.  
  8. All Rights Reserved.
  9.  
  10. The above copyright notice and this permission notice shall be included in
  11. all copies or substantial portions of the Software.
  12.  
  13. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14. IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15. FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
  16. OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  17. AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  18. CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  19.  
  20. Except as contained in this notice, the name of The Open Group shall not be
  21. used in advertising or otherwise to promote the sale, use or other dealings
  22. in this Software without prior written authorization from The Open Group.
  23.  
  24. */
  25.  
  26.  
  27. /*
  28.  * ARGUMENTS:
  29.  *  display             Specifies the connection to the X server. (ignored in EverBlue)
  30.  *  w                   Specifies the window. 
  31.  *  window_name_return  Returns the window name, which is a null-terminated string. 
  32.  * 
  33.  * 
  34.  * DESCRIPTION:
  35.  * The XFetchName() function returns the name of the specified window. If it succeeds, it returns a nonzero status; otherwise, no
  36.  * name has been set for the window, and it returns zero. If the WM_NAME property has not been set for this window,
  37.  * XFetchName() sets window_name_return to NULL. If the data returned by the server is in the Latin Portable Character Encoding,
  38.  * then the returned string is in the Host Portable Character Encoding. Otherwise, the result is implementation dependent. When
  39.  * finished with it, a client must free the window name string using XFree(). 
  40.  * XFetchName() can generate a BadWindow error. 
  41.  * 
  42.  * DIAGNOSTICS:
  43.  * BadWindow   A value for a Window argument does not name a defined Window. 
  44.  */
  45.  
  46. Status XFetchName(Display *display, Window w, char **window_name_return)
  47. {
  48.     Atom actual_type;
  49.     int actual_format;
  50.     unsigned long nitems;
  51.     unsigned long leftover;
  52.     unsigned char *data = NULL;
  53.  
  54.     DBUG_ENTER("XFetchName");
  55.     if (XGetWindowProperty(display, w, XA_WM_NAME, 0L, (long)BUFSIZ, False, XA_STRING, 
  56.     &actual_type,
  57.     &actual_format, &nitems, &leftover, &data) != Success) {
  58.         *window_name_return = NULL;
  59.     DBUG_RETURN(0);
  60.     }
  61.     if ( (actual_type == XA_STRING) &&  (actual_format == 8) ) {
  62.  
  63.     /* The data returned by XGetWindowProperty is guarranteed to
  64.     contain one extra byte that is null terminated to make retrieveing
  65.     string properties easy. */
  66.  
  67.     *window_name_return = (char *)data;
  68.     DBUG_RETURN(1);
  69.     }
  70.     if (data) Xfree ((char *)data);
  71.     *window_name_return = NULL;
  72.     DBUG_RETURN(0);
  73.  
  74.  
  75.  
  76. /* 
  77.  *    This was my first implementation. But now I think it was wrong.
  78.  *    But you never know - so I don't delete it.
  79.  *                        - Rene Auberger
  80.  * 
  81.  *         LONG length;
  82.  * 
  83.  *         DBUG_ENTER("XFetchName");
  84.  */         /* WinQueryAnchorBlock return a NULLHANDLE if the HWND is not valid */
  85. /*         if(WinQueryAnchorBlock(w) == NULLHANDLE){
  86.  *             DBUG_RETURN(BadWindow);
  87.  *         }
  88.  *         length = (WinQueryWindowTextLength(w) * sizeof(char)) + 1;
  89.  *         *window_name_return = malloc(length);
  90.  *         WinQueryWindowText(w, length, *window_name_return);
  91.  *         DBUG_RETURN(Success);
  92.  *
  93.  */
  94. }
  95.