syncok(3xcurses)

1syncok(3XCURSES)        X/Open Curses Library Functions       syncok(3XCURSES)
2
3
4

NAME

6       syncok,  wcursyncup,  wsyncdown,  wsyncup - synchronize window with its
7       parents or children
8

SYNOPSIS

10       cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \
11        -R  /usr/xpg4/lib  -lcurses  [ library... ]
12
13       c89 [ flag... ] file... -lcurses [ library... ]
14
15       #include <curses.h>
16
17       int syncok(WINDOW *win, bool bf);
18
19
20       void wcursyncup(WINDOW *win);
21
22
23       void wsyncdown(WINDOW *win);
24
25
26       void wsyncup(WINDOW *win);
27
28

PARAMETERS

30       win    Is a pointer to a window.
31
32
33       bf     Is a Boolean expression.
34
35

DESCRIPTION

37       The syncok() function uses the value of bf to determine  whether or not
38       the  window  win's ancestors are implicitly touched whenever there is a
39       change to win. If bf is TRUE, this touching occurs. If bf is FALSE,  it
40       does not occur. The initial value for bf is FALSE.
41
42
43       The wcursyncup() function moves the cursor in win's ancestors  to match
44       its position in win.
45
46
47       The wsyncdown() function touches win if any of its ancestors have  been
48       touched.
49
50
51       The wsyncup() function touches all ancestors of win.
52

RETURN VALUES

54       On  success,  the  syncok()  function returns OK. Otherwise, it returns
55       ERR.
56
57
58       The other functions do not return a value.
59

ERRORS

61       None.
62

ATTRIBUTES

64       See attributes(5) for descriptions of the following attributes:
65
66
67
68
69       ┌─────────────────────────────┬─────────────────────────────┐
70       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
71       ├─────────────────────────────┼─────────────────────────────┤
72       │Interface Stability          │Standard                     │
73       ├─────────────────────────────┼─────────────────────────────┤
74       │MT-Level                     │Unsafe                       │
75       └─────────────────────────────┴─────────────────────────────┘
76