XmTextGetSubstringWcs(3X) SDK X11 R4.11MU05 XmTextGetSubstringWcs(3X)
NAME
XmTextGetSubstringWcs--A Text function that retrieves a portion of a
wide character internal text buffer
SYNOPSIS
#include <Xm/Text.h>
int XmTextGetSubstringWcs (widget, start, numchars, buffersize, buffer)
Widget widget;
XmTextPositionstart;
int numchars;
int buffersize;
wchart *buffer;
DESCRIPTION
XmTextGetSubstringWcs retrieves a copy of a portion of the internal
text buffer of a Text widget that is stored in a wide character
format. The function copies a specified number of characters from a
given start position in the internal text buffer into a buffer
provided by the application. A NULL terminator is placed at the end
of the copied data.
widget Specifies the Text widget ID.
start Specifies the beginning character position from which the
data will be retrieved. This is an integer number of
characters from the beginning of the text buffer. The
first character position is 0.
numchars Specifies the number of wchart characters to be copied
into the provided buffer.
buffersize
Specifies the size of the supplied buffer as a number of
wchart storage locations. The minimum size is numchars +
1.
buffer Specifies the wide character buffer into which the internal
text buffer will be copied.
For a complete definition of Text and its associated resources, see
XmText(3X).
RETURN VALUE
XmCOPYSUCCEEDED The function was successful.
XmCOPYFAILED The function failed because it was unable to copy
the specified number of characters into the
buffer provided. The buffer size may be
insufficient. The contents of buffer are
undefined.
XmCOPYTRUNCATED The requested number of characters extended
beyond the internal buffer. The function copied
characters between start and the end of the
widget's buffer and terminated the string with a
NULL terminator; fewer than numchars characters
were copied.
RELATED INFORMATION
XmText(3X) and XmTextGetSubstring(3X).
Licensed material--property of copyright holder(s)