manpagez: man pages & more
man XmStringTableToXmString(3)
Home | html | info | man
XmStringTableToXmString(library call)    XmStringTableToXmString(library call)




NAME

       XmStringTableToXmString  -- A convenience function that converts a com-
       pound string table to a single compound string


SYNOPSIS

       #include <Xm/Xm.h>
       XmString XmStringTableToXmString(
       XmStringTable table,
       Cardinal count,
       XmString break_component);


DESCRIPTION

       XmStringTableToXmString takes as input table of compound strings and  a
       specified  string  component  (such as a tab) and returns a single com-
       pound string consisting of each of the elements of  table  concatenated
       together  with  a  single copy of break_component inserted between each
       element.

       table     Specifies an XmStringTable containing the compound strings to
                 be converted.

       count     Specifies the number of compound strings in table.

       break_component
                 Specifies  the XmStringComponent that will be inserted in the
                 result to separate the individual elements of table. The most
                 useful   types   will   be  XmSTRING_COMPONENT_SEPARATOR  and
                 XmSTRING_COMPONENT_TAB.   Refer  to  the   XmStringComponent-
                 Type(3) reference page for a complete list of possible compo-
                 nent  types.  Note,   however,   that   the   XmSTRING_COMPO-
                 NENT_UNKNOWN component is not a possible type.


RETURN

       Returns  a  new XmString.  The function will allocate space to hold the
       returned compound string.  When the application  no  longer  needs  the
       returned compound string, the application should call XmStringFree.


RELATED

       XmString(3), XmStringComponentType(3), and XmStringFree(3).



                                         XmStringTableToXmString(library call)

openMotif 2.3.1 - Generated Wed Dec 3 18:09:06 CST 2008
© manpagez.com 2000-2025
Individual documents may contain additional copyright information.