home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-bin / x11r6.1 / man / cat3 / xinternatom.0 < prev    next >
Encoding:
Text File  |  1996-10-17  |  5.7 KB  |  199 lines

  1.  
  2.  
  3.  
  4. XInternAtom(3X11)      XLIB FUNCTIONS    XInternAtom(3X11)
  5.  
  6.  
  7. NNAAMMEE
  8.        XInternAtom, XInternAtoms, XGetAtomName, XGetAtomNames -
  9.        create or return atom names
  10.  
  11. SSYYNNTTAAXX
  12.        Atom XInternAtom(_d_i_s_p_l_a_y, _a_t_o_m___n_a_m_e, _o_n_l_y___i_f___e_x_i_s_t_s)
  13.          Display *_d_i_s_p_l_a_y;
  14.          char *_a_t_o_m___n_a_m_e;
  15.          Bool _o_n_l_y___i_f___e_x_i_s_t_s;
  16.  
  17.        Status XInternAtoms(_d_i_s_p_l_a_y, _n_a_m_e_s, _c_o_u_n_t, _o_n_l_y___i_f___e_x_i_s_t_s,
  18.        _a_t_o_m_s___r_e_t_u_r_n)
  19.          Display *_d_i_s_p_l_a_y;
  20.          char **_n_a_m_e_s;
  21.          int _c_o_u_n_t;
  22.          Bool _o_n_l_y___i_f___e_x_i_s_t_s;
  23.          Atom *_a_t_o_m_s___r_e_t_u_r_n;
  24.  
  25.        char *XGetAtomName(_d_i_s_p_l_a_y, _a_t_o_m)
  26.          Display *_d_i_s_p_l_a_y;
  27.          Atom _a_t_o_m;
  28.  
  29.        Status XGetAtomNames(_d_i_s_p_l_a_y, _a_t_o_m_s, _c_o_u_n_t, _n_a_m_e_s___r_e_t_u_r_n)
  30.          Display *_d_i_s_p_l_a_y;
  31.          Atom *_a_t_o_m_s;
  32.          int _c_o_u_n_t;
  33.          char **_n_a_m_e_s___r_e_t_u_r_n;
  34.  
  35. AARRGGUUMMEENNTTSS
  36.        _a_t_o_m     Specifies the atom for the property name you
  37.          want returned.
  38.  
  39.        _a_t_o_m_s     Specifies the array of atoms.
  40.  
  41.        _a_t_o_m___n_a_m_e Specifies the name associated with the atom you
  42.          want returned.
  43.  
  44.        _a_t_o_m_s___r_e_t_u_r_n
  45.          Returns the atoms.
  46.  
  47.        _c_o_u_n_t     Specifies the number of atom names in the array.
  48.  
  49.        _c_o_u_n_t     Specifies the number of atoms in the array.
  50.  
  51.        _d_i_s_p_l_a_y     Specifies the connection to the X server.
  52.  
  53.        _n_a_m_e_s     Specifies the array of atom names.
  54.  
  55.        _n_a_m_e_s___r_e_t_u_r_n
  56.          Returns the atom names.
  57.  
  58.        _o_n_l_y___i_f___e_x_i_s_t_s
  59.          Specifies a Boolean value that indicates whether
  60.          the atom must be created.
  61.  
  62.  
  63.  
  64. X Version 11           Release 6.1                1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XInternAtom(3X11)      XLIB FUNCTIONS    XInternAtom(3X11)
  71.  
  72.  
  73. DDEESSCCRRIIPPTTIIOONN
  74.        The _X_I_n_t_e_r_n_A_t_o_m function returns the atom identifier asso-
  75.        ciated with the specified atom_name string.  If
  76.        only_if_exists is _F_a_l_s_e, the atom is created if it does
  77.        not exist.  Therefore, _X_I_n_t_e_r_n_A_t_o_m can return _N_o_n_e.  If
  78.        the atom name is not in the Host Portable Character Encod-
  79.        ing, the result is implementation-dependent.  Uppercase
  80.        and lowercase matter; the strings ``thing'', ``Thing'',
  81.        and ``thinG'' all designate different atoms.  The atom
  82.        will remain defined even after the client's connection
  83.        closes.    It will become undefined only when the last con-
  84.        nection to the X server closes.
  85.  
  86.        _X_I_n_t_e_r_n_A_t_o_m can generate _B_a_d_A_l_l_o_c and _B_a_d_V_a_l_u_e errors.
  87.  
  88.        The _X_I_n_t_e_r_n_A_t_o_m_s function returns the atom identifiers
  89.        associated with the specified names.  The atoms are stored
  90.        in the atoms_return array supplied by the caller.  Calling
  91.        this function is equivalent to calling _X_I_n_t_e_r_n_A_t_o_m for
  92.        each of the names in turn with the specified value of
  93.        only_if_exists, but this function minimizes the number of
  94.        round-trip protocol exchanges between the client and the X
  95.        server.
  96.  
  97.        This function returns a nonzero status if atoms are
  98.        returned for all of the names; otherwise, it returns zero.
  99.  
  100.        _X_I_n_t_e_r_n_A_t_o_m_s can generate _B_a_d_A_l_l_o_c and _B_a_d_V_a_l_u_e errors.
  101.  
  102.        The _X_G_e_t_A_t_o_m_N_a_m_e function returns the name associated with
  103.        the specified atom.  If the data returned by the server is
  104.        in the Latin Portable Character Encoding, then the
  105.        returned string is in the Host Portable Character Encod-
  106.        ing.  Otherwise, the result is implementation-dependent.
  107.        To free the resulting string, call _X_F_r_e_e.
  108.  
  109.        _X_G_e_t_A_t_o_m_N_a_m_e can generate a _B_a_d_A_t_o_m error.
  110.  
  111.        The _X_G_e_t_A_t_o_m_N_a_m_e_s function returns the names associated
  112.        with the specified atoms.  The names are stored in the
  113.        names_return array supplied by the caller.  Calling this
  114.        function is equivalent to calling _X_G_e_t_A_t_o_m_N_a_m_e for each of
  115.        the atoms in turn, but this function minimizes the number
  116.        of round-trip protocol exchanges between the client and
  117.        the X server.
  118.  
  119.        This function returns a nonzero status if names are
  120.        returned for all of the atoms; otherwise, it returns zero.
  121.  
  122.        _X_G_e_t_A_t_o_m_N_a_m_e_s can generate a _B_a_d_A_t_o_m error.
  123.  
  124. DDIIAAGGNNOOSSTTIICCSS
  125.        _B_a_d_A_l_l_o_c     The server failed to allocate the requested
  126.          resource or server memory.
  127.  
  128.  
  129.  
  130. X Version 11           Release 6.1                2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. XInternAtom(3X11)      XLIB FUNCTIONS    XInternAtom(3X11)
  137.  
  138.  
  139.        _B_a_d_A_t_o_m     A value for an Atom argument does not name a
  140.          defined Atom.
  141.  
  142.        _B_a_d_V_a_l_u_e     Some numeric value falls outside the range of
  143.          values accepted by the request.  Unless a spe-
  144.          cific range is specified for an argument, the
  145.          full range defined by the argument's type is
  146.          accepted.  Any argument defined as a set of
  147.          alternatives can generate this error.
  148.  
  149. SSEEEE AALLSSOO
  150.        XFree(3X11), XGetWindowProperty(3X11)
  151.        _X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196. X Version 11           Release 6.1                3
  197.  
  198.  
  199.