home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-bin / x11r6.1 / man / cat3 / xgettextproperty.0 < prev    next >
Encoding:
Text File  |  1996-10-17  |  4.7 KB  |  133 lines
  1.  
  2.  
  3.  
  4. XSetTextProperty(3X11)      XLIB FUNCTIONS   XSetTextProperty(3X11)
  5.  
  6.  
  7. NNAAMMEE
  8.        XSetTextProperty, XGetTextProperty - set and read text
  9.        properties
  10.  
  11. SSYYNNTTAAXX
  12.        void XSetTextProperty(_d_i_s_p_l_a_y, _w, _t_e_x_t___p_r_o_p, _p_r_o_p_e_r_t_y)
  13.          Display *_d_i_s_p_l_a_y;
  14.          Window _w;
  15.          XTextProperty *_t_e_x_t___p_r_o_p;
  16.          Atom _p_r_o_p_e_r_t_y;
  17.  
  18.        Status XGetTextProperty(_d_i_s_p_l_a_y, _w, _t_e_x_t___p_r_o_p___r_e_t_u_r_n,
  19.        _p_r_o_p_e_r_t_y)
  20.           Display *_d_i_s_p_l_a_y;
  21.           Window _w;
  22.           XTextProperty *_t_e_x_t___p_r_o_p___r_e_t_u_r_n;
  23.           Atom _p_r_o_p_e_r_t_y;
  24.  
  25. AARRGGUUMMEENNTTSS
  26.        _d_i_s_p_l_a_y     Specifies the connection to the X server.
  27.  
  28.        _p_r_o_p_e_r_t_y     Specifies the property name.
  29.  
  30.        _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
  31.          used.
  32.  
  33.        _t_e_x_t___p_r_o_p___r_e_t_u_r_n
  34.          Returns the _X_T_e_x_t_P_r_o_p_e_r_t_y structure.
  35.  
  36. DDEESSCCRRIIPPTTIIOONN
  37.        The _X_S_e_t_T_e_x_t_P_r_o_p_e_r_t_y function replaces the existing speci-
  38.        fied property for the named window with the data, type,
  39.        format, and number of items determined by the value field,
  40.        the encoding field, the format field, and the nitems
  41.        field, respectively, of the specified _X_T_e_x_t_P_r_o_p_e_r_t_y struc-
  42.        ture.  If the property does not already exist, _X_S_e_t_-
  43.        _T_e_x_t_P_r_o_p_e_r_t_y sets it for the specified window.
  44.  
  45.        _X_S_e_t_T_e_x_t_P_r_o_p_e_r_t_y can generate _B_a_d_A_l_l_o_c, _B_a_d_A_t_o_m, _B_a_d_V_a_l_u_e,
  46.        and _B_a_d_W_i_n_d_o_w errors.
  47.  
  48.        The _X_G_e_t_T_e_x_t_P_r_o_p_e_r_t_y function reads the specified property
  49.        from the window and stores the data in the returned
  50.        _X_T_e_x_t_P_r_o_p_e_r_t_y structure.     It stores the data in the value
  51.        field, the type of the data in the encoding field, the
  52.        format of the data in the format field, and the number of
  53.        items of data in the nitems field.  An extra byte contain-
  54.        ing null (which is not included in the nitems member) is
  55.        stored at the end of the value field of text_prop_return.
  56.        The particular interpretation of the property's encoding
  57.        and data as text is left to the calling application.  If
  58.        the specified property does not exist on the window, _X_G_e_t_-
  59.        _T_e_x_t_P_r_o_p_e_r_t_y sets the value field to NULL, the encoding
  60.        field to _N_o_n_e, the format field to zero, and the nitems
  61.  
  62.  
  63.  
  64. X Version 11           Release 6.1                1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XSetTextProperty(3X11)      XLIB FUNCTIONS   XSetTextProperty(3X11)
  71.  
  72.  
  73.        field to zero.
  74.  
  75.        If it was able to read and store the data in the
  76.        _X_T_e_x_t_P_r_o_p_e_r_t_y structure, _X_G_e_t_T_e_x_t_P_r_o_p_e_r_t_y returns a
  77.        nonzero status; otherwise, it returns a zero status.
  78.  
  79.        _X_G_e_t_T_e_x_t_P_r_o_p_e_r_t_y can generate _B_a_d_A_t_o_m and _B_a_d_W_i_n_d_o_w
  80.        errors.
  81.  
  82. PPRROOPPEERRTTIIEESS
  83.        WM_CLIENT_MACHINE
  84.          The string name of the machine on which the
  85.          client application is running.
  86.  
  87.        WM_COMMAND
  88.          The command and arguments, null-separated, used
  89.          to invoke the application.
  90.  
  91.        WM_ICON_NAME
  92.          The name to be used in an icon.
  93.  
  94.        WM_NAME     The name of the application.
  95.  
  96. DDIIAAGGNNOOSSTTIICCSS
  97.        _B_a_d_A_l_l_o_c     The server failed to allocate the requested
  98.          resource or server memory.
  99.  
  100.        _B_a_d_A_t_o_m     A value for an Atom argument does not name a
  101.          defined Atom.
  102.  
  103.        _B_a_d_V_a_l_u_e     Some numeric value falls outside the range of
  104.          values accepted by the request.  Unless a spe-
  105.          cific range is specified for an argument, the
  106.          full range defined by the argument's type is
  107.          accepted.  Any argument defined as a set of
  108.          alternatives can generate this error.
  109.  
  110.        _B_a_d_W_i_n_d_o_w A value for a Window argument does not name a
  111.          defined Window.
  112.  
  113. SSEEEE AALLSSOO
  114.        XAllocClassHint(3X11), XAllocIconSize(3X11), XAllocSize-
  115.        Hints(3X11), XAllocWMHints(3X11), XSetCommand(3X11), XSet-
  116.        TransientForHint(3X11), XSetWMClientMachine(3X11), XSetWM-
  117.        ColormapWindows(3X11), XSetWMIconName(3X11), XSetWM-
  118.        Name(3X11), XSetWMProperties(3X11), XSetWMProtocols(3X11),
  119.        XStringListToTextProperty(3X11)
  120.        _X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130. X Version 11           Release 6.1                2
  131.  
  132.  
  133.