1XmTextFieldGetSubstringWcs(library callX)mTextFieldGetSubstringWcs(library call)
2
3
4

NAME

6       XmTextFieldGetSubstringWcs — A TextField function that retrieves a por‐
7       tion of a wide character internal text buffer
8

SYNOPSIS

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

DESCRIPTION

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

RETURN

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

63       XmTextField(3) and XmTextFieldGetSubstring(3).
64
65
66
67                                      XmTextFieldGetSubstringWcs(library call)
Impressum