home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-bin / x11r6.1 / man / cat3 / xgetwmname.0 < prev    next >
Encoding:
Text File  |  1996-10-17  |  4.4 KB  |  133 lines
  1.  
  2.  
  3.  
  4. XSetWMName(3X11)      XLIB FUNCTIONS     XSetWMName(3X11)
  5.  
  6.  
  7. NNAAMMEE
  8.        XSetWMName, XGetWMName, XStoreName, XFetchName - set or
  9.        read a window's WM_NAME property
  10.  
  11. SSYYNNTTAAXX
  12.        void XSetWMName(_d_i_s_p_l_a_y, _w, _t_e_x_t___p_r_o_p)
  13.          Display *_d_i_s_p_l_a_y;
  14.          Window _w;
  15.          XTextProperty *_t_e_x_t___p_r_o_p;
  16.  
  17.        Status XGetWMName(_d_i_s_p_l_a_y, _w, _t_e_x_t___p_r_o_p___r_e_t_u_r_n)
  18.          Display *_d_i_s_p_l_a_y;
  19.          Window _w;
  20.          XTextProperty *_t_e_x_t___p_r_o_p___r_e_t_u_r_n;
  21.  
  22.        XStoreName(_d_i_s_p_l_a_y, _w, _w_i_n_d_o_w___n_a_m_e)
  23.          Display *_d_i_s_p_l_a_y;
  24.          Window _w;
  25.          char *_w_i_n_d_o_w___n_a_m_e;
  26.  
  27.        Status XFetchName(_d_i_s_p_l_a_y, _w, _w_i_n_d_o_w___n_a_m_e___r_e_t_u_r_n)
  28.          Display *_d_i_s_p_l_a_y;
  29.          Window _w;
  30.          char **_w_i_n_d_o_w___n_a_m_e___r_e_t_u_r_n;
  31.  
  32. AARRGGUUMMEENNTTSS
  33.        _d_i_s_p_l_a_y     Specifies the connection to the X server.
  34.  
  35.        _t_e_x_t___p_r_o_p Specifies the _X_T_e_x_t_P_r_o_p_e_r_t_y structure to be
  36.          used.
  37.  
  38.        _t_e_x_t___p_r_o_p___r_e_t_u_r_n
  39.          Returns the _X_T_e_x_t_P_r_o_p_e_r_t_y structure.
  40.  
  41.        _w     Specifies the window.
  42.  
  43.        _w_i_n_d_o_w___n_a_m_e
  44.          Specifies the window name, which should be a
  45.          null-terminated string.
  46.  
  47.        _w_i_n_d_o_w___n_a_m_e___r_e_t_u_r_n
  48.          Returns the window name, which is a null-
  49.          terminated string.
  50.  
  51. DDEESSCCRRIIPPTTIIOONN
  52.        The _X_S_e_t_W_M_N_a_m_e convenience function calls _X_S_e_t_T_e_x_t_P_r_o_p_e_r_t_y
  53.        to set the WM_NAME property.
  54.  
  55.        The _X_G_e_t_W_M_N_a_m_e convenience function calls _X_G_e_t_T_e_x_t_P_r_o_p_e_r_t_y
  56.        to obtain the WM_NAME property.    It returns a nonzero sta-
  57.        tus on success; otherwise, it returns a zero status.
  58.  
  59.        The _X_S_t_o_r_e_N_a_m_e function assigns the name passed to win-
  60.        dow_name to the specified window.  A window manager can
  61.  
  62.  
  63.  
  64. X Version 11           Release 6.1                1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XSetWMName(3X11)      XLIB FUNCTIONS     XSetWMName(3X11)
  71.  
  72.  
  73.        display the window name in some prominent place, such as
  74.        the title bar, to allow users to identify windows easily.
  75.        Some window managers may display a window's name in the
  76.        window's icon, although they are encouraged to use the
  77.        window's icon name if one is provided by the application.
  78.        If the string is not in the Host Portable Character Encod-
  79.        ing, the result is implementation-dependent.
  80.  
  81.        _X_S_t_o_r_e_N_a_m_e can generate _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w errors.
  82.  
  83.        The _X_F_e_t_c_h_N_a_m_e function returns the name of the specified
  84.        window.    If it succeeds, it returns a nonzero status; oth-
  85.        erwise, no name has been set for the window, and it
  86.        returns zero.  If the WM_NAME property has not been set
  87.        for this window, _X_F_e_t_c_h_N_a_m_e sets window_name_return to
  88.        NULL.  If the data returned by the server is in the Latin
  89.        Portable Character Encoding, then the returned string is
  90.        in the Host Portable Character Encoding.     Otherwise, the
  91.        result is implementation-dependent.  When finished with
  92.        it, a client must free the window name string using _X_F_r_e_e.
  93.  
  94.        _X_F_e_t_c_h_N_a_m_e can generate a _B_a_d_W_i_n_d_o_w error.
  95.  
  96. PPRROOPPEERRTTIIEESS
  97.        WM_NAME     The name of the application.
  98.  
  99. DDIIAAGGNNOOSSTTIICCSS
  100.        _B_a_d_A_l_l_o_c     The server failed to allocate the requested
  101.          resource or server memory.
  102.  
  103.        _B_a_d_W_i_n_d_o_w A value for a Window argument does not name a
  104.          defined Window.
  105.  
  106. SSEEEE AALLSSOO
  107.        XAllocClassHint(3X11), XAllocIconSize(3X11), XAllocSize-
  108.        Hints(3X11), XAllocWMHints(3X11), XFree(3X11), XSetCom-
  109.        mand(3X11), XSetTransientForHint(3X11), XSetTextProp-
  110.        erty(3X11), XSetWMClientMachine(3X11), XSetWMColormapWin-
  111.        dows(3X11), XSetWMIconName(3X11), XSetWMProperties(3X11),
  112.        XSetWMProtocols(3X11), XStringListToTextProperty(3X11)
  113.        _X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130. X Version 11           Release 6.1                2
  131.  
  132.  
  133.