summaryrefslogtreecommitdiff
path: root/doc/xs_msg_data.txt
blob: 64b52957ee550144a6b1440760f19fcd579c8484 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
xs_msg_data(3)
==============


NAME
----
xs_msg_data - retrieve pointer to message content


SYNOPSIS
--------
*void *xs_msg_data (xs_msg_t '*msg');*


DESCRIPTION
-----------
The _xs_msg_data()_ function shall return a pointer to the message content of
the message object referenced by 'msg'.

CAUTION: Never access 'xs_msg_t' members directly, instead always use the
_xs_msg_ family of functions.


RETURN VALUE
------------
Upon successful completion, _xs_msg_data()_ shall return a pointer to the
message content.


ERRORS
------
No errors are defined.


SEE ALSO
--------
linkxs:xs_msg_size[3]
linkxs:xs_msg_init[3]
linkxs:xs_msg_init_size[3]
linkxs:xs_msg_init_data[3]
linkxs:xs_msg_close[3]
linkxs:xs[7]


AUTHORS
-------
The Crossroads documentation was written by Martin Sustrik <sustrik@250bpm.com>
and Martin Lucina <martin@lucina.net>.