1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
'\" t
...\" CvtXmStB.sgm /main/7 1996/08/30 15:03:27 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 "XmCvtXmStringToByteStream" "library call"
.SH "NAME"
\fBXmCvtXmStringToByteStream\fP \(em A compound string function that converts a compound string to a Byte Stream format
.iX "XmCvtXmStringToByteStream"
.iX "compound string functions" "XmCvtXmStringToByteStream"
.SH "SYNOPSIS"
.PP
.nf
#include <Xm/Xm\&.h>
\fBunsigned int \fBXmCvtXmStringToByteStream\fP\fR(
\fBXmString \fBstring\fR\fR,
\fBunsigned char **\fBprop_return\fR\fR);
.fi
.SH "DESCRIPTION"
.PP
\fBXmCvtXmStringToByteStream\fP converts a compound string to a
string of
bytes
representing the compound string in Byte Stream format\&.
This routine is typically used by the source of a data transfer
operation to produce a Byte Stream representation for transferring a compound
string to a destination\&.
.PP
If \fIprop_return\fP is not NULL, this function creates a string of
characters in Byte Stream format and returns it in \fIprop_return\fP\&.
The function also returns the number of bytes in \fIprop_return\fP\&.
If \fIprop_return\fP is NULL, the function does not return the Byte
Stream format
string, but it does calculate and return the number of bytes that would
appear in the Byte Stream format string\&.
.IP "\fIstring\fP" 10
Specifies a compound string to be converted to Byte Stream format
.IP "\fIprop_return\fP" 10
Specifies a pointer to a string in Byte Stream format that is created and
returned by this function\&.
If \fIprop_return\fP is NULL, no Byte Stream format string is returned\&.
When a Byte Stream format string is returned, the function allocates
space to hold it\&.
The application is responsible for managing this allocated space\&.
The application can recover the allocated space by calling \fBXtFree\fP\&.
.SH "RETURN"
.PP
Returns the number of bytes in the Byte Stream representation (whether or not
the Byte Stream representation is returned)\&.
.SH "RELATED"
.PP
\fBXmString\fP(3) and
\fBXmCvtByteStreamToXmString\fP(3)\&.
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:22
|
