noble (3) XmStringToXmStringTable.3.gz

Provided by: libmotif-dev_2.3.8-3.1build1_amd64 bug

NAME
       XmStringToXmStringTable  —  A  convenience  function that converts a single compound string to a table of
       compound strings "XmStringTableToXmString"


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


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 XmSTRING_COMPONENT_SEPARATOR and
                 XmSTRING_COMPONENT_TAB. Refer to the XmStringComponentType(3) reference  page  for  a  complete
                 list  of possible component types. Note, however, that the XmSTRING_COMPONENT_UNKNOWN component
                 is not a possible type.

       table     Returns the equivalent XmStringTable.  The function will allocate space to  hold  the  returned
                 XmStringTable.    When  the  application  no  longer  needs  the  returned  XmStringTable,  the
                 application should call XmStringFree once 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.


       XmStringTable(3).

                                                                                      XmStringToXmStringTable(3)