1XmCvtXmStringToByteStream(library call)XmCvtXmStringToByteStream(library call)
2
3
4

NAME

6       XmCvtXmStringToByteStream  — A compound string function that converts a
7       compound string to a Byte Stream format
8

SYNOPSIS

10       #include <Xm/Xm.h>
11       unsigned int XmCvtXmStringToByteStream(
12       XmString string,
13       unsigned char **prop_return);
14

DESCRIPTION

16       XmCvtXmStringToByteStream converts a compound string  to  a  string  of
17       bytes  representing  the  compound  string in Byte Stream format.  This
18       routine is typically used by the source of a data transfer operation to
19       produce a Byte Stream representation for transferring a compound string
20       to a destination.
21
22       If prop_return is not NULL, this function creates a string  of  charac‐
23       ters in Byte Stream format and returns it in prop_return.  The function
24       also returns the number of bytes in  prop_return.   If  prop_return  is
25       NULL,  the  function does not return the Byte Stream format string, but
26       it does calculate and return the number of bytes that would  appear  in
27       the Byte Stream format string.
28
29       string    Specifies  a  compound  string to be converted to Byte Stream
30                 format
31
32       prop_return
33                 Specifies a pointer to a string in Byte Stream format that is
34                 created  and  returned  by  this function.  If prop_return is
35                 NULL, no Byte Stream format string is returned.  When a  Byte
36                 Stream  format  string  is  returned,  the function allocates
37                 space to hold it.  The application is responsible for  manag‐
38                 ing  this  allocated  space.  The application can recover the
39                 allocated space by calling XtFree.
40

RETURN

42       Returns the number of bytes in the Byte Stream representation  (whether
43       or not the Byte Stream representation is returned).
44

46       XmString(3) and XmCvtByteStreamToXmString(3).
47
48
49
50                                       XmCvtXmStringToByteStream(library call)
Impressum