'\" t
.\" StrToX.sgm /main/10 1996/09/08 21:07:51 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 "XmStringToXmStringTable" 3
.SH "NAME"
\fBXmStringToXmStringTable\fP \(em A convenience function that converts a single compound string to a table of compound strings
"XmStringTableToXmString"
.SH "SYNOPSIS"
.PP
.nf
#include <Xm/Xm\&.h>
\fBCardinal \fBXmStringToXmStringTable\fP\fR(
\fBXmString \fBstring\fR\fR,
\fBXmString \fBbreak_component\fR\fR,
\fBXmStringTable \fB*table\fR\fR);
.fi
.SH "DESCRIPTION"
.PP
\fBXmStringToXmStringTable\fP 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 \fIstring\fP delimited by components
matching \fIbreak_component\fP\&. The components marking breaks will
not appear in the resulting table\&.
.IP "\fIstring\fP" 10
Specifies the \fBXmString\fR to be converted\&.
.IP "\fIbreak_component\fP" 10
Specifies the \fBXmStringComponent\fP that will be used to indicate
where to split \fIstring\fP to form 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\&.
.IP "\fItable\fP" 10
Returns the equivalent \fBXmStringTable\fR\&.
The function will allocate space to hold the returned \fBXmStringTable\fR\&.
When the application no longer needs the returned \fBXmStringTable\fR,
the application should call \fBXmStringFree\fP
once for each compound string in the table,
and then calling \fBXtFree\fP to deallocate the \fBXmStringTable\fR itself\&.
.SH "RETURN"
.PP
Returns the number of compound strings in \fItable\fP\&.
.SH "RELATED"
.PP
\fBXmStringTable\fP(3)\&.
.\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:32