XmStringToXmStringTable()



     XmStringToXmStringTable(3XUNIX System XmStringToXmStringTable(3X)



     NAME
          XmStringToXmStringTable - A convenience function that
          converts a single compound string to a table of compound
          strings

     SYNOPSIS
          #include <Xm/Xm.h>
          Cardinal XmStringToXmStringTable(
          XmString string,
          XmString breakcomponent,
          XmStringTable *table);

     VERSION
          This page documents Motif 2.1.

     DESCRIPTION
          XmStringToXmStringTable takes as input a single compound
          string and a specified string component (such as a tab) and
          returns a table of compound strings consisting of portions
          of string delimited by components matching break_component.
          The components marking breaks will not appear in the
          resulting table.

          string    Specifies the XmString to be converted.

          break_component
                    Specifies the XmStringComponent that will be used
                    to indicate where to split string to form the
                    individual elements of table. The most useful
                    types will be XmSTRINGCOMPONENTSEPARATOR and
                    XmSTRINGCOMPONENTTAB. Refer to the
                    XmStringComponentType(3) reference page for a
                    complete list of possible component types. Note,
                    however, that the XmSTRINGCOMPONENTUNKNOWN
                    component is not a possible type.

          table     Returns the equivalent XmStringTable.  The
                    function will allocate space to hold the returned
                    XmStringTable.  When the applicaiton no longer
                    needs the returned XmStringTable, the application
                    should call XmStringFreeonce for each compound
                    string in the table, and then calling XtFree to
                    deallocate the XmStringTable itself.

     RETURN
          Returns the number of compound strings in table.

     RELATED
          XmStringTable(3).






     Page 1                                          (printed 1/22/99)
Museum
