Blame doc/man/man3/XmStringTableParseStringArray.3

Packit b099d7
'\" t
Packit b099d7
...\" StrTaB.sgm /main/9 1996/09/08 21:07:19 rws $
Packit b099d7
.de P!
Packit b099d7
.fl
Packit b099d7
\!!1 setgray
Packit b099d7
.fl
Packit b099d7
\\&.\"
Packit b099d7
.fl
Packit b099d7
\!!0 setgray
Packit b099d7
.fl			\" force out current output buffer
Packit b099d7
\!!save /psv exch def currentpoint translate 0 0 moveto
Packit b099d7
\!!/showpage{}def
Packit b099d7
.fl			\" prolog
Packit b099d7
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
Packit b099d7
\!!psv restore
Packit b099d7
.
Packit b099d7
.de pF
Packit b099d7
.ie     ?\\*(f1?? .ds f1 \\n(.f
Packit b099d7
.el .ie ?\\*(f2?? .ds f2 \\n(.f
Packit b099d7
.el .ie ?\\*(f3?? .ds f3 \\n(.f
Packit b099d7
.el .ie ?\\*(f4?? .ds f4 \\n(.f
Packit b099d7
.el .tm ? font overflow
Packit b099d7
.ft \\$1
Packit b099d7
..
Packit b099d7
.de fP
Packit b099d7
.ie     !?\\*(f4?? \{\
Packit b099d7
.	ft \\*(f4
Packit b099d7
.	ds f4\"
Packit b099d7
'	br \}
Packit b099d7
.el .ie !?\\*(f3?? \{\
Packit b099d7
.	ft \\*(f3
Packit b099d7
.	ds f3\"
Packit b099d7
'	br \}
Packit b099d7
.el .ie !?\\*(f2?? \{\
Packit b099d7
.	ft \\*(f2
Packit b099d7
.	ds f2\"
Packit b099d7
'	br \}
Packit b099d7
.el .ie !?\\*(f1?? \{\
Packit b099d7
.	ft \\*(f1
Packit b099d7
.	ds f1\"
Packit b099d7
'	br \}
Packit b099d7
.el .tm ? font underflow
Packit b099d7
..
Packit b099d7
.ds f1\"
Packit b099d7
.ds f2\"
Packit b099d7
.ds f3\"
Packit b099d7
.ds f4\"
Packit b099d7
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
Packit b099d7
.TH "XmStringTableParseStringArray" "library call"
Packit b099d7
.SH "NAME"
Packit b099d7
\fBXmStringTableParseStringArray\fP \(em A convenience function that converts an array of strings to a compound string table
Packit b099d7
.iX "XmStringTableParseStringArray"
Packit b099d7
.SH "SYNOPSIS"
Packit b099d7
.PP
Packit b099d7
.nf
Packit b099d7
#include <Xm/Xm\&.h>
Packit b099d7
\fBXmStringTable \fBXmStringTableParseStringArray\fP\fR(
Packit b099d7
\fBXtPointer \fB*strings\fR\fR,
Packit b099d7
\fBCardinal \fBcount\fR\fR,
Packit b099d7
\fBXmStringTag \fBtag\fR\fR,
Packit b099d7
\fBXmTextType \fBtype\fR\fR,
Packit b099d7
\fBXmParseTable \fBparse\fR\fR,
Packit b099d7
\fBCardinal \fBparse_count\fR\fR,
Packit b099d7
\fBXtPointer \fBcall_data\fR\fR);
Packit b099d7
.fi
Packit b099d7
.SH "DESCRIPTION"
Packit b099d7
.PP
Packit b099d7
\fBXmStringTableParseStringArray\fP takes an array of strings,
Packit b099d7
allocates an \fBXmStringTable\fR with an equal number of slots, calls
Packit b099d7
\fBXmStringParseText\fP on each string in \fIstrings\fP, and inserts
Packit b099d7
the resulting \fBXmString\fR in the corresponding slot in the
Packit b099d7
\fBXmStringTable\fR\&.
Packit b099d7
.IP "\fIstrings\fP" 10
Packit b099d7
Specifies an array of strings of characters as determined by
Packit b099d7
\fItype\fP\&.
Packit b099d7
.IP "\fIcount\fP" 10
Packit b099d7
Specifies the number of strings in \fIstrings\fP\&.
Packit b099d7
.IP "\fItag\fP" 10
Packit b099d7
Specifies the tag to be used in creating the result\&. The type of tag
Packit b099d7
created (charset or locale) depends on the type of the text and
Packit b099d7
the value given\&. If the value specified is NULL, and \fItype\fP
Packit b099d7
indicates that a charset tag should be created, then the tag will
Packit b099d7
have the value of
Packit b099d7
\fBXmFONTLIST_DEFAULT_TAG\fP\&.
Packit b099d7
If \fItype\fP
Packit b099d7
indicates a locale tag, then the tag will have the value of
Packit b099d7
\fBXmFONTLIST_DEFAULT_TAG\fP\&.
Packit b099d7
.IP "\fItype\fP" 10
Packit b099d7
Specifies the type of text to be passed in and the type of tag\&. If
Packit b099d7
the type is either \fBXmMULTIBYTE_TEXT\fP or \fBXmWIDECHAR_TEXT\fP, a
Packit b099d7
locale tag should be created\&. If the type is \fBXmCHARSET_TEXT\fP, a
Packit b099d7
charset tag
Packit b099d7
will
Packit b099d7
be created\&.
Packit b099d7
.IP "\fIparse\fP" 10
Packit b099d7
Specifies the parse table to be used\&.
Packit b099d7
.IP "\fIparse_count\fP" 10
Packit b099d7
Specifies the number of entries in the parse table\&.
Packit b099d7
.IP "\fIcall_data\fP" 10
Packit b099d7
Specifies data to be passed to the parse procedures\&.
Packit b099d7
.SH "RETURN"
Packit b099d7
.PP
Packit b099d7
Returns a new \fBXmStringTable\fR\&.
Packit b099d7
The function allocates space to hold the \fBXmStringTable\fR\&.
Packit b099d7
When the application no longer needs the returned \fBXmStringTable\fR,
Packit b099d7
the application should call \fBXmStringFree\fP
Packit b099d7
\fIcount\fP times (that is, one time for each returned compound string)
Packit b099d7
and then call \fBXtFree\fP to deallocate the \fBXmStringTable\fR itself\&.
Packit b099d7
.SH "RELATED"
Packit b099d7
.PP
Packit b099d7
\fBXmStringFree\fP(3) and
Packit b099d7
\fBXmTabList\fP(3)\&.
Packit b099d7
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:32