XmTextFindString(3X) UNIX System V XmTextFindString(3X)
NAME
XmTextFindString - A Text function that finds the beginning
position of a text string
SYNOPSIS
#include <Xm/Xm.h>
Boolean XmTextFindString (widget, start, string, direction, position)
Widget widget;
XmTextPositionstart;
char *string;
XmTextDirectiondirection;
XmTextPosition*position;
VERSION
This page documents version 1.2 of the Motif library.
DESCRIPTION
XmTextFindString locates the beginning position of a
specified text string. This routine searches forward or
backward for the first occurrence of the string starting
from the given start position. If it finds a match, 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.
string Specifies the search string.
direction
Indicates the search direction. It is relative to
the primary direction of the text. The possible
values are
XmTEXTFORWARD The search proceeds toward the end
of the text buffer.
XmTEXTBACKWARD The search proceeds toward the
beginning of the text buffer.
position
Specifies the pointer in which the first character
position of the string match is returned. This is an
Page 1 (printed 4/30/98)
XmTextFindString(3X) UNIX System V XmTextFindString(3X)
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 XmTextFindStringWcs(3X).
Page 2 (printed 4/30/98)