Museum

Home

Lab Overview

Retrotechnology Articles

Online Manuals

⇒ XmTeFindB(Xm) — OpenDesktop Software Development System 3.0.0

Media Vault

Software Library

Restoration Projects

Artifacts Sought


 XmTextFindStringWcs(Xm)        6 January 1993        XmTextFindStringWcs(Xm)


 Name

    XmTextFindStringWcs - a Text function that finds the beginning position
    of a wide character text string

 Syntax


    #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 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:

            +  XmTEXTFORWARD -- the search proceeds toward the end of the
               buffer.

            +  XmTEXTBACKWARD -- 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 char-
            acters from the beginning of the buffer. The first character
            position is 0. If the function returns False, this value is unde-
            fined.

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

 Return value

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

 See also

    XmText(Xm) and XmTextFindString(Xm).


Typewritten Software • bear@typewritten.org • Edmonds, WA 98026