home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / X11 / XStringListToTextProperty.z / XStringListToTextProperty
Encoding:
Text File  |  2002-10-03  |  6.3 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXSSSSttttrrrriiiinnnnggggLLLLiiiissssttttTTTTooooTTTTeeeexxxxttttPPPPrrrrooooppppeeeerrrrttttyyyy((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXSSSSttttrrrriiiinnnnggggLLLLiiiissssttttTTTTooooTTTTeeeexxxxttttPPPPrrrrooooppppeeeerrrrttttyyyy((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XStringListToTextProperty, XTextPropertyToStringList,
  10.           XFreeStringList, XTextProperty - convert string lists and
  11.           text property structure
  12.  
  13.      SSSSYYYYNNNNTTTTAAAAXXXX
  14.           Status XStringListToTextProperty(_l_i_s_t, _c_o_u_n_t,
  15.           _t_e_x_t__p_r_o_p__r_e_t_u_r_n)
  16.                 char **_l_i_s_t;
  17.                 int _c_o_u_n_t;
  18.                 XTextProperty *_t_e_x_t__p_r_o_p__r_e_t_u_r_n;
  19.  
  20.           Status XTextPropertyToStringList(_t_e_x_t__p_r_o_p, _l_i_s_t__r_e_t_u_r_n,
  21.           _c_o_u_n_t__r_e_t_u_r_n)
  22.                  XTextProperty *_t_e_x_t__p_r_o_p;
  23.                  char ***_l_i_s_t__r_e_t_u_r_n;
  24.                  int *_c_o_u_n_t__r_e_t_u_r_n;
  25.  
  26.           void XFreeStringList(_l_i_s_t)
  27.                 char **_l_i_s_t;
  28.  
  29.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  30.           _c_o_u_n_t     Specifies the number of strings.
  31.  
  32.           _c_o_u_n_t__r_e_t_u_r_n
  33.                     Returns the number of strings.
  34.  
  35.           _l_i_s_t      Specifies the list of strings to be freed.
  36.  
  37.           _l_i_s_t      Specifies a list of null-terminated character
  38.                     strings.
  39.  
  40.           _l_i_s_t__r_e_t_u_r_n
  41.                     Returns a list of null-terminated character
  42.                     strings.
  43.  
  44.           _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 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.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  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 (which
  54.           is not included in the nitems member) is stored at the end
  55.           of the value field of text_prop_return.  The strings are
  56.           assumed (without verification) to be in the STRING encoding.
  57.           If insufficient memory is available for the new value
  58.           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 set any fields in
  59.           the _X_T_e_x_t_P_r_o_p_e_r_t_y structure and returns a zero status.
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXSSSSttttrrrriiiinnnnggggLLLLiiiissssttttTTTTooooTTTTeeeexxxxttttPPPPrrrrooooppppeeeerrrrttttyyyy((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXSSSSttttrrrriiiinnnnggggLLLLiiiissssttttTTTTooooTTTTeeeexxxxttttPPPPrrrrooooppppeeeerrrrttttyyyy((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.           Otherwise, it returns a nonzero status.  To free the storage
  75.           for the value field, use _X_F_r_e_e.
  76.  
  77.           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
  78.           strings representing the null-separated elements of the
  79.           specified _X_T_e_x_t_P_r_o_p_e_r_t_y structure.  The data in text_prop
  80.           must be of type STRING and format 8. Multiple elements of
  81.           the property (for example, the strings in a disjoint text
  82.           selection) are separated by NULL (encoding 0).  The contents
  83.           of the property are not null-terminated.  If insufficient
  84.           memory is available for the list and its elements,
  85.           _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 returns
  86.           a zero status.  Otherwise, it returns a nonzero status.  To
  87.           free the storage for the list and its contents, use
  88.           _X_F_r_e_e_S_t_r_i_n_g_L_i_s_t.
  89.  
  90.           The _X_F_r_e_e_S_t_r_i_n_g_L_i_s_t function releases memory allocated by
  91.           _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 and
  92.           the missing charset list allocated by _X_C_r_e_a_t_e_F_o_n_t_S_e_t.
  93.  
  94.      SSSSTTTTRRRRUUUUCCCCTTTTUUUURRRREEEESSSS
  95.           The _X_T_e_x_t_P_r_o_p_e_r_t_y structure contains:
  96.  
  97.           typedef struct {
  98.                unsigned char *value;/* property data */
  99.                Atom encoding;      /* type of property */
  100.                int format;         /* 8, 16, or 32 */
  101.                unsigned long nitems;/* number of items in value */
  102.           } XTextProperty;
  103.  
  104.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  105.           XAllocClassHint(3X11), XAllocIconSize(3X11),
  106.           XAllocSizeHints(3X11), XAllocWMHints(3X11), XFree(3X11),
  107.           XSetCommand(3X11), XSetTransientForHint(3X11),
  108.           XSetTextProperty(3X11), XSetWMClientMachine(3X11),
  109.           XSetWMColormapWindows(3X11), XSetWMIconName(3X11),
  110.           XSetWMName(3X11), XSetWMProperties(3X11),
  111.           XSetWMProtocols(3X11)
  112.           _X_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.