docs: Formatting cleanups, consistency
[jimtcl.git] / jim-tty.h
blobd052d73764015734912acde2cc052d63cba4da24
1 #ifndef JIM_TTY_H
2 #define JIM_TTY_H
4 #include <jim.h>
6 #ifdef __cplusplus
7 extern "C" {
8 #endif
10 /**
11 * Return the tty settings for the given file descriptor as a dictionary
12 * with a zero reference count.
14 * Returns NULL and sets errno file descriptor is not a valid tty.
16 Jim_Obj *Jim_GetTtySettings(Jim_Interp *interp, int fd);
18 /**
19 * Sets the tty settings given in 'dictObjPtr'
21 * Returns JIM_OK if OK, JIM_ERR if any settings are invalid,
22 * or -1 (and sets errno) if the file descriptor is not a valid tty.
24 int Jim_SetTtySettings(Jim_Interp *interp, int fd, Jim_Obj *dictObjPtr);
26 #ifdef __cplusplus
28 #endif
30 #endif