XmCvtXmStringToByteStream(library call) XmCvtXmStringToByteStream(library call)
NAME
XmCvtXmStringToByteStream -- A compound string function that converts a compound string to a Byte Stream format
SYNOPSIS
#include <Xm/Xm.h>
unsigned int XmCvtXmStringToByteStream(
XmString string,
unsigned char **prop_return);
DESCRIPTION
XmCvtXmStringToByteStream 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.
If prop_return is not NULL, this function creates a string of characters in Byte Stream format and returns it in prop_return. The function
also returns the number of bytes in prop_return. If prop_return 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.
string Specifies a compound string to be converted to Byte Stream format
prop_return
Specifies a pointer to a string in Byte Stream format that is created and returned by this function. If prop_return 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
XtFree.
RETURN
Returns the number of bytes in the Byte Stream representation (whether or not the Byte Stream representation is returned).
RELATED XmString(3) and XmCvtByteStreamToXmString(3).
XmCvtXmStringToByteStream(library call)
Check Out this Related Man Page
XmCvtXmStringTableToTextProperty(library call) XmCvtXmStringTableToTextProperty(library call)
NAME
XmCvtXmStringTableToTextProperty -- A function that converts from XmStringTable to an XTextProperty Structure
SYNOPSIS
#include <Xm/Xm.h>
int XmCvtXmStringTableToTextProperty (display, string_table, count, style, text_prop_return)
Display *display;
XmStringTable string_table;
int count;
XmICCEncodingStyle style;
XTextProperty *text_prop_return;
(void)
DESCRIPTION
XmCvtXmStringTableToTextProperty converts the XmStrings in the specified XmStringTable into an XTextProperty structure.
The function sets the encoding member of text_prop_return to an Atom for the specified display naming the encoding determined by the speci-
fied style, and it converts the first count compound strings in the specified XmStringTable to this encoding for storage in the
text_prop_return value member. Following are the possible encoding styles:
XmSTYLE_COMPOUND_STRING
The encoding is _MOTIF_COMPOUND_STRING. The function converts each specified XmString to a compound string in Byte Stream format.
XmSTYLE_COMPOUND_TEXT
The encoding is COMPOUND_TEXT. The function converts each specified XmString to compound text.
XmSTYLE_LOCALE
The encoding is the encoding of the current locale. The function converts each specified XmString to the encoding of the current
locale.
XmSTYLE_STRING
The encoding is STRING (plain C strings encoded in ISO8859-1), and the function converts each specified XmString to STRING.
XmSTYLE_TEXT
If all specified XmStrings are fully convertible to the encoding of the current locale, the encoding is the encoding of the cur-
rent locale, and the function converts each specified XmString to the encoding of the current locale. Otherwise, the encoding is
COMPOUND_TEXT, and the function converts each specified compound string to compound text.
XmSTYLE_STANDARD_ICC_TEXT
If all specified XmStrings are fully convertible to STRING, the encoding is STRING, and the function converts each specified
XmString to STRING. Otherwise, the encoding is COMPOUND_TEXT, and the function converts each specified XmString to compound text.
display Specifies the connection to the X server.
string_table
Specifies a set of XmStrings.
count Specifies the number of XmStrings to be converted in string_table.
style Specifies the manner in which the property is encoded.
text_prop_return
Returns the XTextProperty structure.
To free the storage for the value member of the XTextProperty, use XtFree.
RETURN VALUES
If conversion depends on the locale and the current locale is not supported, the function returns XLocaleNotSupported. In both of these
cases, the function does not set text_prop_return.
To determine whether the function is guaranteed not to return XLocaleNotSupported, use XSupportsLocale.
RELATED INFORMATION XmCvtXmStringToByteStream(3), XmCvtTextPropertyToXmStringTable(3), and XmStringTable(3).
XmCvtXmStringTableToTextProperty(library call)