Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

xmstringgetnextsegment(3) [hpux man page]

XmStringGetNextSegment(library call)									      XmStringGetNextSegment(library call)

NAME
XmStringGetNextSegment -- A compound string function that fetches the bytes in the next segment of a compound string SYNOPSIS
#include <Xm/Xm.h> Boolean XmStringGetNextSegment( XmStringContext context, char **text, XmStringTag *tag, XmStringDirection *direction, Boolean *separator); DESCRIPTION
This routine is obsolete and exists for compatibility with previous releases. To read the contents of a compound string, read each compo- nent of the string with XmStringGetNextTriple. This XmString function returns the type, length, and value of the next component in the com- pound string. XmStringGetNextSegment fetches the bytes 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. If the function returns True, then the function allocates space to hold the returned text and tag. The application is responsible for man- aging the allocated space. The application can recover the allocated space by calling XtFree. 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
Returns True if a valid segment is found. RELATED
XmStringCreate(3) and XmStringInitContext(3). XmStringGetNextSegment(library call)

Check Out this Related Man Page

XmStringSegmentCreate(library call)									       XmStringSegmentCreate(library call)

NAME
XmStringSegmentCreate -- A compound string function that creates a compound string SYNOPSIS
#include <Xm/Xm.h> XmString XmStringSegmentCreate( char * text, XmStringTag tag, XmStringDirection direction, Boolean separator); DESCRIPTION
This function is obsolete and exists for compatibility with previous releases. It can be replaced by using a combination of XmStringCompo- nentCreate and XmStringConcat. XmStringSegmentCreate is a high-level function that assembles a compound string consisting of a font list element tag, a direction component, a text component, and an optional separator component. The function allocates space for the returned compound string. The application is responsible for managing the allocated space. The application can recover the allocated space by calling XmStringFree. text Specifies a NULL-terminated string to be used as the text component of the compound string. tag Specifies the tag component to be associated with the text. The value XmFONTLIST_DEFAULT_TAG is for compatibility with previous releases. direction Specifies the direction of the text. separator A value of False means the compound string does not have a separator at the end. A value of True, means a separator immediately follows the text component. RETURN
Returns a new compound string. RELATED
XmStringCreate(3). XmStringSegmentCreate(library call)
Man Page