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

NAME

6       XmTextGetSubstringWcs  —  A Text function that retrieves a portion of a
7       wide character internal text buffer
8

SYNOPSIS

10       #include <Xm/Text.h>
11       int XmTextGetSubstringWcs(
12       Widget widget,
13       XmTextPosition start,
14       int num_chars,
15       int buffer_size,
16       wchar_t *buffer);
17

DESCRIPTION

19       XmTextGetSubstringWcs retrieves a copy of a  portion  of  the  internal
20       text buffer of a Text widget that is stored in a wide character format.
21       The function copies a specified number of characters from a given start
22       position  in  the  internal  text  buffer into a buffer provided by the
23       application. A NULL terminator is placed at the end of the copied data.
24
25       widget    Specifies the Text widget ID.
26
27       start     Specifies the beginning character  position  from  which  the
28                 data  will be retrieved. This is an integer number of charac‐
29                 ters from the beginning of the text buffer. The first charac‐
30                 ter position is 0 (zero).
31
32       num_chars Specifies  the number of wchar_t characters to be copied into
33                 the provided buffer.
34
35       buffer_size
36                 Specifies the size of the supplied  buffer  as  a  number  of
37                 wchar_t storage locations. The minimum size is num_chars + 1.
38
39       buffer    Specifies  the  wide character buffer into which the internal
40                 text buffer will be copied.
41
42       For a complete definition of Text and  its  associated  resources,  see
43       XmText(3).
44

RETURN

46       XmCOPY_SUCCEEDED
47                 The function was successful.
48
49       XmCOPY_FAILED
50                 The  function failed because it was unable to copy the speci‐
51                 fied number of characters into the buffer provided.  The buf‐
52                 fer  size  may  be  insufficient.  The contents of buffer are
53                 undefined.
54
55       XmCOPY_TRUNCATED
56                 The requested number of characters extended beyond the inter‐
57                 nal  buffer. The function copied characters between start and
58                 the end of the widget's buffer and terminated the string with
59                 a  NULL  terminator;  fewer  than  num_chars  characters were
60                 copied.
61

RELATED

63       XmText(3) and XmTextGetSubstring(3).
64
65
66
67                                           XmTextGetSubstringWcs(library call)