Museum

 XmStringGetNextSegment(Xm)     6 January 1993     XmStringGetNextSegment(Xm)


 Name

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

 Syntax


    #include <Xm/Xm.h>

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


 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.

 See also

    XmStringCreate(Xm) and XmStringInitContext(Xm).