[Contents] [Index] [Next] [Previous]

XmStringGetNextComponent


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, tag, direction, unknown_tag,
          unknown_length, unknown_value)
      XmStringContext        context;
      char                   **text;
      XmStringCharSet        *tag;
      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, tag, and direction components, only one output parameter is valid. If the return status indicates an unknown component was encountered, the font list element 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.
tag
Specifies a pointer to the font list element tag 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 VALUE

Returns the type of component found. Following are the possible values:

RELATED INFORMATION

XmStringCreate(3X) and XmStringInitContext(3X).