summaryrefslogtreecommitdiff
path: root/doc/xs_version.txt
blob: c13a0808cdc905803169f12f8210e8023b44ba9a (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
49
50
51
52
53
xs_version(3)
=============


NAME
----
xs_version - report Crossroads library version


SYNOPSIS
--------
*void xs_version (int '*major', int '*minor', int '*patch');*


DESCRIPTION
-----------
The _xs_version()_ function shall fill in the integer variables pointed to by
the 'major', 'minor' and 'patch' arguments with the major, minor and patch level
components of the Crossroads library version.

This functionality is intended for applications or language bindings
dynamically linking to the Crossroads library that wish to determine the actual
version of the Crossroads library they are using.


RETURN VALUE
------------
There is no return value.


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


EXAMPLE
-------
.Printing out the version of the Crossroads library
----
int major, minor, patch;
xs_version (&major, &minor, &patch);
printf ("Current Crossroads version is %d.%d.%d\n", major, minor, patch);
----


SEE ALSO
--------
linkxs:xs[7]

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