XMTEXTGETSUBSTRING(3)

💖 XmTextGetSubstring 💖

okay so bestie, welcome to XmTextGetSubstring — she's a library call straight out of the XmText family, and she's here to grab you a lil copy of part of a Text widget's internal text buffer. no big deal. just a queen doing queen things. 👑

---

✨ SYNOPSIS ✨

#include <Xm/Text.h>
int XmTextGetSubstring(
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 characters 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. slay, it's that simple. 💅

ngl the size of the required buffer depends on the maximum number of bytes per character (MB_CUR_MAX) for the current locale. MB_CUR_MAX 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:

buffer_size = (num_chars* MB_CUR_MAX) + 1
(void)

like, do the math bestie, don't come crying to me when your buffer is too small 😭

• widget — Specifies the Text widget ID. it's giving "which widget are we even talking about" energy, so yeah, you gotta tell her.
• 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 (zero). zero-indexed, iconic, no notes.
• num_chars — Specifies the number of characters to be copied into the provided buffer.
• buffer_size — Specifies the size of the supplied buffer in bytes. This size should account for a NULL terminator. yes, the terminator counts. she always counts. 🎀
• 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(3). go read it, i'll wait 🫶

---

🔥 RETURN 🔥

• XmCOPY_SUCCEEDED — The function was successful. we ate. ✨
• XmCOPY_FAILED — 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.

⚠️ bestie listen to me: if you get XmCOPY_FAILED, the contents of buffer are undefined. not "kinda off", not "mostly fine" — undefined. do not read it. do not print it. do not pass go. 💀

• XmCOPY_TRUNCATED — 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 terminator; fewer than num_chars characters were copied. she gave you what she had, okay? she's doing her best 🥺

---

🌈 RELATED 🌈

XmText(3) and XmTextGetSubstringWcs(3).

---

and that's the whole vibe check, bestie 💜 this has been XmTextGetSubstring, filed under library call, right there in the XmText corner of the manual — go forth and copy substrings responsibly. mwah. 💋 🦋 🌸