XmStringGetNextComponent(library call) XmStringGetNextComponent(library call)
NAMEXmStringGetNextComponent — 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(
XmStringContext context,
char **text,
XmStringTag *tag,
XmStringDirection *direction,
XmStringComponentType *unknown_tag,
unsigned short *unknown_length,
unsigned char **unknown_value);
DESCRIPTION
This function is obsolete and exists for compatibility with previous
releases. It is replaced by XmStringGetNextTriple. XmStringGetNextCom‐
ponent returns the type and value of the next component in the compound
string identified by context. Components are returned one at a time.
On return, only some output parameters will be valid; which ones can be
determined by examining the returned component type. The following ta‐
ble describes the valid returns for each component type.
┌─────────────────────┬──────────────────────────────┐
│Valid Fields │ Component Type │
├─────────────────────┼──────────────────────────────┤
│tag │ XmSTRING_COMPONENT_LOCALE, │
│ │ XmSTRING_COMPONENT_TAG │
├─────────────────────┼──────────────────────────────┤
│text │ XmSTRING_COMPO‐ │
│ │ NENT_LOCALE_TEXT, │
│ │ XmSTRING_COMPONENT_TEXT, │
│ │ XmSTRING_COMPO‐ │
│ │ NENT_WIDECHAR_TEXT │
├─────────────────────┼──────────────────────────────┤
│direction │ XmSTRING_COMPONENT_DIRECTION │
├─────────────────────┼──────────────────────────────┤
│unknown_tag, │ XmSTRING_COMPONENT_LAY‐ │
│unknown_length, │ OUT_POP, XmSTRING_COMPO‐ │
│unknown_value │ NENT_LAYOUT_PUSH, │
│ │ XmSTRING_COMPONENT_TAB, │
│ │ XmSTRING_COMPONENT_RENDI‐ │
│ │ TION_BEGIN, XmSTRING_COMPO‐ │
│ │ NENT_RENDITION_END │
├─────────────────────┼──────────────────────────────┤
│no valid field │ XmSTRING_COMPONENT_SEPARA‐ │
│ │ TOR, XmSTRING_COMPONENT_END, │
│ │ XmSTRING_COMPONENT_UNKNOWN │
├─────────────────────┼──────────────────────────────┤
└─────────────────────┴──────────────────────────────┘
Note that several components produce a return value of XmSTRING_COMPO‐
NENT_UNKNOWN. The data returned by these components is returned in the
unknown_tag, unknown_length, and unknown_value fields. This apparent
inconsistency is designed to accomodate older applications that may not
be equipped to handle the newer component types of Motif version 2.0
and beyond. Consequently, the use of this procedure is not recom‐
mended. Instead, use the XmStringGetNextTriple procedure, which pro‐
vides all the functionality of XmStringGetNextComponent, and is fully
compatible with the newer component types.
If the function return value is XmSTRING_COMPONENT_LOCALE_TEXT or
XmSTRING_COMPONENT_TEXT, the the function allocates space to hold the
returned text. If the function return value is XmSTRING_COMPO‐
NENT_FONTLIST_ELEMENT_TAG, or XmSTRING_COMPONENT_TAG, then the function
allocates space to hold the returned tag. The application is responsi‐
ble for managing the allocated space. The application can recover the
allocated space by calling XtFree.
context Specifies the string context structure that was allocated by
the XmStringInitContext function.
text Specifies a pointer to a NULL terminated string.
tag Specifies a pointer to the tag component associated with the
text. The value XmFONTLIST_DEFAULT_TAG identifies a locale
text segment.
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.
RETURN
Returns the type of component found. Refer to the XmStringComponent‐
Type(3) reference page for a list of component types.
RELATEDXmStringComponentType(3), XmStringCreate(3), and XmStringInitCon‐
text(3).
XmStringGetNextComponent(library call)
