XmStringGetNextSegment(3X)

NAME
     XmStringGetNextSegment --A compound string function that fetches the octets
     in the next segment of a compound string

SYNOPSIS
     #include <Xm/Xm.h>

     Boolean XmStringGetNextSegment (context, text, tag, direction, separator)
          XmStringContextcontext;
          char           **text;
          XmStringCharSet*tag;
          XmStringDirection*direction;
          Boolean        *separator;


VERSION
     This page documents version 1.2 of the Motif library.

DESCRIPTION
     XmStringGetNextSegment  fetches  the  octets  in the next segment; repeated
     calls fetch sequential segments.  The  text,  tag,  and  direction  of  the
     fetched  segment  are  returned each time.  A Boolean status is returned to
     indicate whether a valid segment was successfully parsed.


     context   Specifies the string context structure which was allocated by the
               XmStringInitContext function.

     text      Specifies a pointer to a null terminated string.

     tag       Specifies a pointer to the font list element tag associated  with
               the text.

     direction Specifies a pointer to the direction of the text.

     separator Specifies  whether the next component of the compound string is a
               separator.


RETURN VALUE
     Returns True if a valid segment is found.

RELATED INFORMATION
     XmStringCreate(3X) and XmStringInitContext(3X).

                                                      XmStringGetNextSegment(3X)