XmStringGetNextComponent(3X) UNIX System V XmStringGetNextComponent(3X)
NAME
XmStringGetNextComponent - a compound string function that returns the
type and value of the next component in a compound string.
SYNOPSIS
#include <Xm/Xm.h>
XmStringComponentType XmStringGetNextComponent (context, text, charset,
direction, xunknown_tag, unknown_length, unknown_value)
XmStringContext context;
char ** text;
XmStringCharSet * charset;
XmStringDirection* direction;
XmStringComponentType* unknown_tag;
unsigned short * unknown_length;
unsigned char ** unknown_value;
DESCRIPTION
XmStringGetNextComponent returns the type and value of the next component
in the compound string identified by context. It is a low-level
component function. Components are returned one at a time. On return,
only some output parameters will be valid; which ones can be determined
by examining the return status. In the case of text, charset, and
direction components, only one output parameter is valid. If the return
status indicates an unknown component was encountered, the tag, length,
and value are returned. This function allocates the space necessary to
hold returned values; freeing this space is the caller's responsibility.
context Specifies the string context structure which was allocated by
the XmStringInitContext function.
text Specifies a pointer to a null terminated string.
charset Specifies a pointer to the character set identifier associated
with the text.
direction Specifies a pointer to the direction of the text.
unknown_tag Specifies a pointer to the tag of an unknown component.
unknown_length
Specifies a pointer to the length of an unknown component.
unknown_value
Specifies a pointer to the value of an unknown component.
10/89 Page 1
XmStringGetNextComponent(3X) UNIX System V XmStringGetNextComponent(3X)
RETURN VALUE
Returns the type of component found. Following are the possible values:
⊕ XmSTRING_COMPONENT_CHARSET
⊕ XmSTRING_COMPONENT_TEXT
⊕ XmSTRING_COMPONENT_DIRECTION
⊕ XmSTRING_COMPONENT_SEPARATOR
⊕ XmSTRING_COMPONENT_END
⊕ XmSTRING_COMPONENT_UNKNOWN
RELATED INFORMATION
XmStringCreate(3X) and XmStringInitContext(3X).
Page 2 10/89