home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-bin / x11r6.1 / man / cat3 / xfreestringlist.0 < prev    next >
Encoding:
Text File  |  1996-10-17  |  4.6 KB  |  133 lines
  1.  
  2.  
  3.  
  4. XStringListToTextProperty(3XXL1I1B)FUNCXTSItOrNiSngListToTextProperty(3X11)
  5.  
  6.  
  7. NNAAMMEE
  8.        XStringListToTextProperty, XTextPropertyToStringList,
  9.        XFreeStringList, XTextProperty - convert string lists and
  10.        text property structure
  11.  
  12. SSYYNNTTAAXX
  13.        Status XStringListToTextProperty(_l_i_s_t, _c_o_u_n_t,
  14.        _t_e_x_t___p_r_o_p___r_e_t_u_r_n)
  15.          char **_l_i_s_t;
  16.          int _c_o_u_n_t;
  17.          XTextProperty *_t_e_x_t___p_r_o_p___r_e_t_u_r_n;
  18.  
  19.        Status XTextPropertyToStringList(_t_e_x_t___p_r_o_p, _l_i_s_t___r_e_t_u_r_n,
  20.        _c_o_u_n_t___r_e_t_u_r_n)
  21.           XTextProperty *_t_e_x_t___p_r_o_p;
  22.           char ***_l_i_s_t___r_e_t_u_r_n;
  23.           int *_c_o_u_n_t___r_e_t_u_r_n;
  24.  
  25.        void XFreeStringList(_l_i_s_t)
  26.          char **_l_i_s_t;
  27.  
  28. AARRGGUUMMEENNTTSS
  29.        _c_o_u_n_t     Specifies the number of strings.
  30.  
  31.        _c_o_u_n_t___r_e_t_u_r_n
  32.          Returns the number of strings.
  33.  
  34.        _l_i_s_t     Specifies the list of strings to be freed.
  35.  
  36.        _l_i_s_t     Specifies a list of null-terminated character
  37.          strings.
  38.  
  39.        _l_i_s_t___r_e_t_u_r_n
  40.          Returns a list of null-terminated character
  41.          strings.
  42.  
  43.        _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
  44.          used.
  45.  
  46.        _t_e_x_t___p_r_o_p___r_e_t_u_r_n
  47.          Returns the _X_T_e_x_t_P_r_o_p_e_r_t_y structure.
  48.  
  49. DDEESSCCRRIIPPTTIIOONN
  50.        The _X_S_t_r_i_n_g_L_i_s_t_T_o_T_e_x_t_P_r_o_p_e_r_t_y function sets the specified
  51.        _X_T_e_x_t_P_r_o_p_e_r_t_y to be of type STRING (format 8) with a value
  52.        representing the concatenation of the specified list of
  53.        null-separated character strings.  An extra null byte
  54.        (which is not included in the nitems member) is stored at
  55.        the end of the value field of text_prop_return.    The
  56.        strings are assumed (without verification) to be in the
  57.        STRING encoding.     If insufficient memory is available for
  58.        the new value string, _X_S_t_r_i_n_g_L_i_s_t_T_o_T_e_x_t_P_r_o_p_e_r_t_y does not
  59.        set any fields in the _X_T_e_x_t_P_r_o_p_e_r_t_y structure and returns
  60.        a zero status.  Otherwise, it returns a nonzero status.
  61.  
  62.  
  63.  
  64. X Version 11           Release 6.1                1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XStringListToTextProperty(3XXL1I1B)FUNCXTSItOrNiSngListToTextProperty(3X11)
  71.  
  72.  
  73.        To free the storage for the value field, use _X_F_r_e_e.
  74.  
  75.        The _X_T_e_x_t_P_r_o_p_e_r_t_y_T_o_S_t_r_i_n_g_L_i_s_t function returns a list of
  76.        strings representing the null-separated elements of the
  77.        specified _X_T_e_x_t_P_r_o_p_e_r_t_y structure.  The data in text_prop
  78.        must be of type STRING and format 8.  Multiple elements of
  79.        the property (for example, the strings in a disjoint text
  80.        selection) are separated by NULL (encoding 0).  The con-
  81.        tents of the property are not null-terminated.  If insuf-
  82.        ficient memory is available for the list and its elements,
  83.        _X_T_e_x_t_P_r_o_p_e_r_t_y_T_o_S_t_r_i_n_g_L_i_s_t sets no return values and
  84.        returns a zero status.  Otherwise, it returns a nonzero
  85.        status.    To free the storage for the list and its con-
  86.        tents, use _X_F_r_e_e_S_t_r_i_n_g_L_i_s_t.
  87.  
  88.        The _X_F_r_e_e_S_t_r_i_n_g_L_i_s_t function releases memory allocated by
  89.        _X_m_b_T_e_x_t_P_r_o_p_e_r_t_y_T_o_T_e_x_t_L_i_s_t and _X_T_e_x_t_P_r_o_p_e_r_t_y_T_o_S_t_r_i_n_g_L_i_s_t
  90.        and the missing charset list allocated by _X_C_r_e_a_t_e_F_o_n_t_S_e_t.
  91.  
  92. SSTTRRUUCCTTUURREESS
  93.        The _X_T_e_x_t_P_r_o_p_e_r_t_y structure contains:
  94.  
  95.        typedef struct {
  96.         unsigned char *value;/* property data */
  97.         Atom encoding;    /* type of property */
  98.         int format;        /* 8, 16, or 32 */
  99.         unsigned long nitems;/* number of items in value */
  100.        } XTextProperty;
  101.  
  102. SSEEEE AALLSSOO
  103.        XAllocClassHint(3X11), XAllocIconSize(3X11), XAllocSize-
  104.        Hints(3X11), XAllocWMHints(3X11), XFree(3X11), XSetCom-
  105.        mand(3X11), XSetTransientForHint(3X11), XSetTextProp-
  106.        erty(3X11), XSetWMClientMachine(3X11), XSetWMColormapWin-
  107.        dows(3X11), XSetWMIconName(3X11), XSetWMName(3X11),
  108.        XSetWMProperties(3X11), XSetWMProtocols(3X11)
  109.        _X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  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.