xmcvtxmstringtobytestream(3) [redhat man page]

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)

XmCvtXmStringToCT(library call) 										   XmCvtXmStringToCT(library call)

NAME

       XmCvtXmStringToCT -- A compound string function that converts a compound string to compound text

SYNOPSIS

       #include <Xm/Xm.h>
       char * XmCvtXmStringToCT(
       XmString string);

DESCRIPTION

       XmCvtXmStringToCT  converts  a  compound  string  to  a (char *) string in compound text format.  The application must call XtAppInitialize
       before calling this function.  The converter uses the font list tag associated with a given compound string segment to  select  a  compound
       text  format for that segment.  A registry defines a mapping between font list tags and compound text encoding formats.	The converter uses
       the following algorithm for each compound string segment:

	  1. If the compound string segment tag is mapped to XmFONTLIST_DEFAULT_TAG in the registry, the converter passes the text of the compound
	     string  segment  to  XmbTextListToTextProperty  with an encoding style of XCompoundTextStyle and uses the resulting compound text for
	     that segment.

	  2. If the compound string segment tag is mapped to an MIT registered charset in the registry, the converter creates  the  compound  text
	     for  that	segment  using	the charset (from the registry) and the text of the compound string segment as defined in the X Consortium
	     Standard Compound Text Encoding.

	  3. If the compound string segment tag is mapped to a charset in the registry that is neither XmFONTLIST_DEFAULT_TAG nor  an  MIT  regis-
	     tered  charset,  the  converter  creates the compound text for that segment using the charset (from the registry) and the text of the
	     compound string segment as an "extended segment" with a variable number of octets per character.

	  4. If the compound string segment tag is not mapped in the registry, the result is implementation dependent.

       string	 Specifies a compound string to be converted to compound text.

RETURN

       Returns a (char *) string in compound text format.  This format is described in the X Consortium  Standard  Compound  Text  Encoding.   The
       function  allocates  space  to hold the returned string.  The application is responsible for managing the allocated space.  The application
       can recover the allocated space by calling XtFree.

RELATED

       XmCvtCTToXmString(3), XmFontList(3), XmMapSegmentEncoding(3), XmRegisterSegmentEncoding(3), and XmString.

														   XmCvtXmStringToCT(library call)