1ptree_post_event(3PICLTREPEI)CL Plug-In Library Functiopntsree_post_event(3PICLTREE)
2
3
4

NAME

6       ptree_post_event - post a PICL event
7

SYNOPSIS

9       cc [ flag... ] file... -lpicltree [ library... ]
10       #include <picltree.h>
11
12       int ptree_post_event(const char *ename, const void *earg,
13            size_t size, void (*completion_handler)(char *ename,
14            void *earg, size_t size));
15
16

DESCRIPTION

18       The ptree_post_event() function posts the specified event and its argu‐
19       ments to the PICL framework. The argument ename specifies a pointer  to
20       a  string containing the name of the PICL event. The arguments earg and
21       size specify a pointer to a buffer containing the event  arguments  and
22       size  of  that  buffer,  respectively.  The argument completion_handler
23       specifies the completion handler to be called after the event has  been
24       dispatched to all handlers. A NULL value for a completion handler indi‐
25       cates that no handler should be called. The PICL framework invokes  the
26       completion handler of an event with the ename, earg, and size arguments
27       specified at the time of the posting of the event.
28
29
30       PICL events are dispatched in the order in which they were posted. They
31       are  dispatched  by  executing  the handlers registered for that event.
32       The handlers are invoked in the order in which they were registered.
33
34
35       New events will not begin execution until all previous events have fin‐
36       ished  execution.  Specifically,  an event posted from an event handler
37       will not begin execution until the current event  has  finished  execu‐
38       tion.
39
40
41       The  caller  may not reuse or reclaim the resources associated with the
42       event name and arguments until the invocation of  the  completion  han‐
43       dler.   The  completion  handlers  are  normally  used  to  reclaim any
44       resources allocated for the posting of an event.
45

RETURN VALUES

47       Upon successful completion, 0 is returned. On failure,  a  non-negative
48       integer  is returned to indicate an error, the event is not posted, and
49       the completion handler is not invoked.
50

ERRORS

52       PICL_INVALIDARG    Invalid argument
53
54
55       PICL_FAILURE       General system failure
56
57

ATTRIBUTES

59       See attributes(5) for descriptions of the following attributes:
60
61
62
63
64       ┌─────────────────────────────┬─────────────────────────────┐
65       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
66       ├─────────────────────────────┼─────────────────────────────┤
67       │Interface Stability          │Evolving                     │
68       ├─────────────────────────────┼─────────────────────────────┤
69       │MT-Level                     │MT-Safe                      │
70       └─────────────────────────────┴─────────────────────────────┘
71

SEE ALSO

73       ptree_register_handler(3PICLTREE), ptree_unregister_handler(3PICLTREE),
74       attributes(5)
75
76
77
78SunOS 5.11                        1 Aug 2000       ptree_post_event(3PICLTREE)
Impressum