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)
XmStringContextcontext;
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. 

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

textSpecifies a pointer to a null terminated string. 

charsetSpecifies a pointer to the character set identifier associated with the text. 

directionSpecifies a pointer to the direction of the text. 

unknown_tagSpecifies a pointer to the tag of an unknown component. 

unknown_lengthSpecifies a pointer to the length of an unknown component. 

unknown_valueSpecifies a pointer to the value of an unknown component. 

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). 

September 02, 1992