Museum

 XmTextGetSubstring(Xm)         6 January 1993         XmTextGetSubstring(Xm)


 Name

    XmTextGetSubstring - a Text function that retrieves a copy of a portion
    of the internal text buffer

 Syntax


    #include <Xm/Text.h>

    int XmTextGetSubstring (widget, start, num_chars, buffer_size, buffer)
    Widget  widget;
    XmTextPosition start;
    int  num_chars;
    int  buffer_size;
    char  *buffer;


 Description

    XmTextGetSubstring retrieves a copy of a portion of the internal text
    buffer of a Text widget. The function copies a specified number of char-
    acters from a given start position in the internal text buffer into a
    buffer provided by the application. A NULL terminator is placed at the
    end of the copied data.

    The size of the required buffer depends on the maximum number of bytes
    per character (MBCURMAX) for the current locale.  MBCURMAX is a macro
    defined in stdlib.h. The buffer should be large enough to contain the
    substring to be copied and a NULL terminator. Use the following equation
    to calculate the size of buffer the application should provide:

       buffersize = (numchars * MBCURMAX) + 1


    widget  Specifies the Text widget ID.

    start   Specifies the beginning character position from which the data
            will be retrieved. This is an integer number of characters from
            the beginning of the text buffer. The first character position is
            0.

    numchars
            Specifies the number of characters to be copied into the provided
            buffer.

    buffersize
            Specifies the size of the supplied buffer in bytes. This size
            should account for a NULL terminator.

    buffer  Specifies the character buffer into which the internal text
            buffer will be copied.

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

 Return value

    XmCOPYSUCCEEDED
            The function was successful.

    XmCOPYFAILED
            The function failed because it was unable to copy the specified
            number of characters into the buffer provided.  The buffer size
            may be insufficient. The contents of buffer are undefined.

    XmCOPYTRUNCATED
            The requested number of characters extended beyond the internal
            buffer. The function copied characters between start and the end
            of the widget's buffer and terminated the string with a NULL ter-
            minator; fewer than numchars characters were copied.

 See also

    XmText(Xm) and XmTextGetSubstringWcs(Xm).