XTextProper(3x) — HPUX 9.05

NAME

XTextPropertyToStringList − obtain a list of strings from a specified XTextProperty structure.

Synopsis

Status XTextPropertyToStringList(text_prop, list_return, count_return)

   XTextProperty *text_prop;
   char ***list_return;
   int *count_return;

Arguments

text_propSpecifies the XTextProperty structure to be used.

list_return
Returns a list of null-terminated character strings.

count_return
Returns the number of strings.

Availability

Release 4 and later.

Description

XTextPropertyToStringList() returns a list of strings representing the null-separated elements of the specified XTextProperty structure. The data in text_prop must be of type STRING and format 8. Multiple elements of the property (for example, the strings in a disjoint text selection) are separated by a NULL (encoding 0). The contents of the property 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 non-zero status. To free the storage for the list and its contents, use XFreeStringList(). For more information, see Volume One, Chapter 10, Interclient Communication.

Structures

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