Museum

 XmStringGetNextComponent(Xm)   6 January 1993   XmStringGetNextComponent(Xm)


 Name

    XmStringGetNextComponent - a compound string function that returns the
    type and value of the next component in a compound string

 Syntax


    #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 examin-
    ing the return status. In the case of text, tag, and direction com-
    ponents, only one output parameter is valid. If the return status indi-
    cates an unknown component was encountered, the font list element tag,
    length, and value are returned. This function allocates the space neces-
    sary to hold returned values; freeing this space is the caller's respon-
    sibility.

    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 XmFONTLISTDEFAULTTAG identifies a locale
            text segment.

    direction
            Specifies a pointer to the direction of the text.

    unknowntag
            Specifies a pointer to the tag of an unknown component.

    unknownlength
            Specifies a pointer to the length of an unknown component.

    unknownvalue
            Specifies a pointer to the value of an unknown component.

 Return value

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

    +  XmSTRINGCOMPONENTCHARSET -- This component is obsolete and remains
       for compatibility with previous releases. It has been replaced by
       XmSTRINGCOMPONENTFONTLISTELEMENTTAG.

    +  XmSTRINGCOMPONENTFONTLISTELEMENTTAG

    +  XmSTRINGCOMPONENTLOCALETEXT

    +  XmSTRINGCOMPONENTTAG

    +  XmSTRINGCOMPONENTTEXT

    +  XmSTRINGCOMPONENTDIRECTION

    +  XmSTRINGCOMPONENTSEPARATOR

    +  XmSTRINGCOMPONENTEND

    +  XmSTRINGCOMPONENTUNKNOWN

 See also

    XmStringCreate(Xm) and XmStringInitContext(Xm).