1XmStringGetNextSegment(library call)      XmStringGetNextSegment(library call)
2
3
4

NAME

6       XmStringGetNextSegment  —  A  compound string function that fetches the
7       bytes in the next segment of a compound string
8

SYNOPSIS

10       #include <Xm/Xm.h>
11       Boolean XmStringGetNextSegment(
12       XmStringContext context,
13       char **text,
14       XmStringTag *tag,
15       XmStringDirection *direction,
16       Boolean *separator);
17

DESCRIPTION

19       This routine is obsolete and exists  for  compatibility  with  previous
20       releases.  To  read the contents of a compound string, read each compo‐
21       nent of the string with XmStringGetNextTriple. This  XmString  function
22       returns  the  type, length, and value of the next component in the com‐
23       pound string.  XmStringGetNextSegment fetches the  bytes  in  the  next
24       segment;  repeated  calls fetch sequential segments. The text, tag, and
25       direction of the fetched segment are returned each time. A Boolean sta‐
26       tus  is  returned  to indicate whether a valid segment was successfully
27       parsed.
28
29       If the function returns True, then the function allocates space to hold
30       the  returned text and tag. The application is responsible for managing
31       the allocated space. The application can recover the allocated space by
32       calling XtFree.
33
34       context   Specifies the string context structure which was allocated by
35                 the XmStringInitContext function
36
37       text      Specifies a pointer to a NULL-terminated string
38
39       tag       Specifies a pointer to the font list element  tag  associated
40                 with the text
41
42       direction Specifies a pointer to the direction of the text
43
44       separator Specifies  whether  the next component of the compound string
45                 is a separator
46

RETURN

48       Returns True if a valid segment is found.
49

51       XmStringCreate(3) and XmStringInitContext(3).
52
53
54
55                                          XmStringGetNextSegment(library call)
Impressum