curs_get_wstr - Linux

Overview

curs_get_wstr() is a curses API function that returns a wide-character string, user-defined string, representing the current value of the specified pad.

Syntax

const wchar_t *curs_get_wstr(WINDOW *win)

Options/Flags

None.

Examples

Simple Usage:

WINDOW *win;
const wchar_t *str;

str = curs_get_wstr(win);

Complex Usage:

#include <curses.h>

int main() {
  WINDOW *win;
  const wchar_t *str;

  initscr();

  // Create a pad with a text string
  win = newpad(10, 20);
  waddstr(win, L"Wide-character string");

  // Get the current value of the pad as a wide-character string
  str = curs_get_wstr(win);
  // Use the string as needed...

  delwin(win);
  endwin();

  return 0;
}

Common Issues

Ensure that the window specified in the curs_get_wstr() function is a pad, as attempting to use it on a normal window will result in unpredictable behavior.

Integration

curs_get_wstr() can be combined with other curses functions to manipulate and display wide-character strings in a terminal window. For instance, it can be used with waddwstr() to add a wide-character string to the current pad.

Related Commands

• curs_getstr()
• waddwstr()
• wgetch()