'\" t
...\" StrTaD.sgm /main/9 1996/09/08 21:07:35 rws $
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl			\" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl			\" prolog
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
.ie     \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie     !\\*(f4 \{\
.	ft \\*(f4
.	ds f4\"
'	br \}
.el .ie !\\*(f3 \{\
.	ft \\*(f3
.	ds f3\"
'	br \}
.el .ie !\\*(f2 \{\
.	ft \\*(f2
.	ds f2\"
'	br \}
.el .ie !\\*(f1 \{\
.	ft \\*(f1
.	ds f1\"
'	br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
.TH "XmStringTableToXmString" "library call"
.SH "NAME"
\fBXmStringTableToXmString\fP \(em A convenience function that converts a compound string table to a single compound string
.iX "XmStringTableToXmString"
.SH "SYNOPSIS"
.PP
.nf
#include <Xm/Xm\&.h>
\fBXmString \fBXmStringTableToXmString\fP\fR(
\fBXmStringTable \fBtable\fR\fR,
\fBCardinal \fBcount\fR\fR,
\fBXmString \fBbreak_component\fR\fR);
.fi
.SH "DESCRIPTION"
.PP
\fBXmStringTableToXmString\fP takes as input \fItable\fP of compound
strings and a specified
string component (such as a tab) and returns a single compound
string consisting of
each of the elements of \fItable\fP concatenated together with a
single copy of \fIbreak_component\fP inserted between each element\&.
.IP "\fItable\fP" 10
Specifies an \fBXmStringTable\fR containing the compound strings to be
converted\&.
.IP "\fIcount\fP" 10
Specifies the number of compound strings in \fItable\fP\&.
.IP "\fIbreak_component\fP" 10
Specifies the \fBXmStringComponent\fP that will be inserted in the
result to separate the individual elements of \fItable\fP\&. The most
useful types will be \fBXmSTRING_COMPONENT_SEPARATOR\fP and
\fBXmSTRING_COMPONENT_TAB\fP\&.
Refer to the
\fBXmStringComponentType\fP(3) reference page for a complete list of
possible component types\&. Note, however, that the
\fBXmSTRING_COMPONENT_UNKNOWN\fP component is not a possible type\&.
.SH "RETURN"
.PP
Returns a new \fBXmString\fR\&.
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 \fBXmStringFree\fP\&.
.SH "RELATED"
.PP
\fBXmString\fP(3),
\fBXmStringComponentType\fP(3), and
\fBXmStringFree\fP(3)\&.
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:32