XStringListToTextProperty(3X11)XLIB FUNCTIONS XStringListToTextProperty(3X11)



NAME
  XStringListToTextProperty, XTextPropertyToStringList, XFreeStringList,
  XTextProperty - convert string lists and text property structure

SYNTAX
  Status XStringListToTextProperty(list, count, text_prop_return)
	char **list;
	int count;
	XTextProperty *text_prop_return;

  Status XTextPropertyToStringList(text_prop, list_return, count_return)
	 XTextProperty *text_prop;
	 char ***list_return;
	 int *count_return;

  void XFreeStringList(list)
	char **list;

ARGUMENTS

  count	    Specifies the number of strings.

  count_return
	    Returns the number of strings.

  list	    Specifies the list of strings to be freed.

  list	    Specifies a list of null-terminated character strings.

  list_return
	    Returns a list of null-terminated character strings.

  text_prop Specifies the XTextProperty structure to be used.

  text_prop_return
	    Returns the XTextProperty structure.

DESCRIPTION
  The XStringListToTextProperty function sets the specified XTextProperty to
  be of type STRING (format 8) with a value representing the concatenation of
  the specified list of null-separated character strings.  An extra null byte
  (which is not included in the nitems member) is stored at the end of the
  value field of text_prop_return.  The strings are assumed (without verifi-
  cation) to be in the STRING encoding.	 If insufficient memory is available
  for the new value string, XStringListToTextProperty does not set any fields
  in the XTextProperty structure and returns a zero status.  Otherwise, it
  returns a nonzero status.  To free the storage for the value field, use
  XFree.

  The XTextPropertyToStringList function returns a list of strings represent-
  ing the null-separated elements of the specified XTextProperty structure.
  The data in text_prop must be of type STRING and format 8. Multiple ele-
  ments of the property (for example, the strings in a disjoint text
  selection) are separated by NULL (encoding 0).  The contents of the pro-
  perty are not null-terminated.  If insufficient memory is available for the
  list and its elements, XTextPropertyToStringList sets no return values and
  returns a zero status.  Otherwise, it returns a nonzero status.  To free
  the storage for the list and its contents, use XFreeStringList.

  The XFreeStringList function releases memory allocated by XmbTextProper-
  tyToTextList and XTextPropertyToStringList and the missing charset list
  allocated by XCreateFontSet.

STRUCTURES
  The XTextProperty structure contains:

  typedef struct {
       unsigned char *value;/* property data */
       Atom encoding;	   /* type of property */
       int format;	   /* 8, 16, or 32 */
       unsigned long nitems;/* number of items in value */
  } XTextProperty;

SEE ALSO
  XAllocClassHint(3X11), XAllocIconSize(3X11), XAllocSizeHints(3X11),
  XAllocWMHints(3X11), XFree(3X11), XSetCommand(3X11),
  XSetTransientForHint(3X11), XSetTextProperty(3X11),
  XSetWMClientMachine(3X11), XSetWMColormapWindows(3X11),
  XSetWMIconName(3X11), XSetWMName(3X11), XSetWMProperties(3X11),
  XSetWMProtocols(3X11)
  Xlib - C Language X Interface