home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-bin / x11r6.1 / man / cat3 / xseticonname.0 < prev    next >
Encoding:
Text File  |  1996-10-17  |  4.1 KB  |  133 lines
  1.  
  2.  
  3.  
  4. XSetWMIconName(3X11)      XLIB FUNCTIONS     XSetWMIconName(3X11)
  5.  
  6.  
  7. NNAAMMEE
  8.        XSetWMIconName, XGetWMIconName, XSetIconName, XGetIconName
  9.        - set or read a window's WM_ICON_NAME property
  10.  
  11. SSYYNNTTAAXX
  12.        void XSetWMIconName(_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 XGetWMIconName(_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.        XSetIconName(_d_i_s_p_l_a_y, _w, _i_c_o_n___n_a_m_e)
  23.          Display *_d_i_s_p_l_a_y;
  24.          Window _w;
  25.          char *_i_c_o_n___n_a_m_e;
  26.  
  27.        Status XGetIconName(_d_i_s_p_l_a_y, _w, _i_c_o_n___n_a_m_e___r_e_t_u_r_n)
  28.          Display *_d_i_s_p_l_a_y;
  29.          Window _w;
  30.          char **_i_c_o_n___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.        _i_c_o_n___n_a_m_e Specifies the icon name, which should be a null-
  36.          terminated string.
  37.  
  38.        _i_c_o_n___n_a_m_e___r_e_t_u_r_n
  39.          Returns the window's icon name, which is a null-
  40.          terminated string.
  41.  
  42.        _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
  43.          used.
  44.  
  45.        _t_e_x_t___p_r_o_p___r_e_t_u_r_n
  46.          Returns the _X_T_e_x_t_P_r_o_p_e_r_t_y structure.
  47.  
  48.        _w     Specifies the window.
  49.  
  50. DDEESSCCRRIIPPTTIIOONN
  51.        The _X_S_e_t_W_M_I_c_o_n_N_a_m_e convenience function calls _X_S_e_t_-
  52.        _T_e_x_t_P_r_o_p_e_r_t_y to set the WM_ICON_NAME property.
  53.  
  54.        The _X_G_e_t_W_M_I_c_o_n_N_a_m_e convenience function calls _X_G_e_t_-
  55.        _T_e_x_t_P_r_o_p_e_r_t_y to obtain the WM_ICON_NAME property.  It
  56.        returns a nonzero status on success; otherwise, it returns
  57.        a zero status.
  58.  
  59.        The _X_S_e_t_I_c_o_n_N_a_m_e function sets the name to be displayed in
  60.        a window's icon.
  61.  
  62.  
  63.  
  64. X Version 11           Release 6.1                1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XSetWMIconName(3X11)      XLIB FUNCTIONS     XSetWMIconName(3X11)
  71.  
  72.  
  73.        _X_S_e_t_I_c_o_n_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.
  74.  
  75.        The _X_G_e_t_I_c_o_n_N_a_m_e function returns the name to be displayed
  76.        in the specified window's icon.    If it succeeds, it
  77.        returns a nonzero status; otherwise, if no icon name has
  78.        been set for the window, it returns zero.  If you never
  79.        assigned a name to the window, _X_G_e_t_I_c_o_n_N_a_m_e sets
  80.        icon_name_return to NULL.  If the data returned by the
  81.        server is in the Latin Portable Character Encoding, then
  82.        the returned string is in the Host Portable Character
  83.        Encoding.  Otherwise, the result is implementation-
  84.        dependent.  When finished with it, a client must free the
  85.        icon name string using _X_F_r_e_e.
  86.  
  87.        _X_G_e_t_I_c_o_n_N_a_m_e can generate a _B_a_d_W_i_n_d_o_w error.
  88.  
  89. PPRROOPPEERRTTIIEESS
  90.        WM_ICON_NAME
  91.          The name to be used in an icon.
  92.  
  93. DDIIAAGGNNOOSSTTIICCSS
  94.        _B_a_d_A_l_l_o_c     The server failed to allocate the requested
  95.          resource or server memory.
  96.  
  97.        _B_a_d_W_i_n_d_o_w A value for a Window argument does not name a
  98.          defined Window.
  99.  
  100. SSEEEE AALLSSOO
  101.        XAllocClassHint(3X11), XAllocIconSize(3X11), XAllocSize-
  102.        Hints(3X11), XAllocWMHints(3X11), XFree(3X11), XSetCom-
  103.        mand(3X11), XSetTransientForHint(3X11), XSetTextProp-
  104.        erty(3X11), XSetWMClientMachine(3X11), XSetWMColormapWin-
  105.        dows(3X11), XSetWMName(3X11), XSetWMProperties(3X11),
  106.        XSetWMProtocols(3X11), XStringListToTextProperty(3X11)
  107.        _X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  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.