XmTextFindStringWcs(3X)
Prev | Reference Pages | Next

## Name

XmTextFindStringWcs(3X) — XmTextFindStringWcs--A Text function that finds the beginning position of a wide character text string XmTextFindStringWcsText functions

## Synopsis

#include <Xm/Text.h>
Boolean XmTextFindStringWcs (`widget, start, wcstring, direction, position`)
Widget `widget`;
XmTextPosition `start`;
wchar_t *`wcstring`;
XmTextDirection `direction`;
XmTextPosition *`position`;

## DESCRIPTION

XmTextFindStringWcs locates the beginning position of a specified wide character text string. This routine searches forward or backward for the first occurrence of the string, starting from the given start position. If a match is not found, the search wraps to the beginning of the buffer (or to the end when `direction` is XmTEXT_BACKWARD) and continues to the initial start position. If a match is found, the function returns the position of the first character of the string in `position`.

`widget` |  | Specifies the Text widget ID.
`start` |  | Specifies the character position from which the search proceeds. This is an integer number of characters from the beginning of the text buffer. The first character position is 0.
`wcstring` |  | Specifies the wide character search string.
`direction` |  | Indicates the search direction. It is relative to the primary direction of the text. The possible values are
XmTEXT_FORWARD |  | The search proceeds toward the end of the buffer.
XmTEXT_BACKWARD |  | The search proceeds toward the beginning of the buffer.
`position` |  | Specifies the pointer in which the first character position of the string match is returned. This is an integer number of characters from the beginning of the buffer. The first character position is 0. If the function returns False, this value is undefined.

For a complete definition of Text and its associated resources, see XmText(3X).

## RETURN VALUE

Returns True if a string match is found; otherwise, returns False.

## RELATED INFORMATION

XmText(3X) and XmTextFindString(3X).

Prev | Table of Contents | Next
XmTextFindString(3X) |  | XmTextGetBaseline(3X)