libsxmp/man/sxhub_set_priv.3

59 lines
1.1 KiB
Groff
Raw Normal View History

2015-10-27 00:20:44 +02:00
.TH SXHUB_SET_PRIV 3 "20 July 2015" "SXMP" "SXMP Library Manual"
2015-07-26 06:02:27 +03:00
.SH NAME
2015-11-13 14:16:08 +02:00
sxhub_set_priv \- Set a private pointer to the links hub
2015-07-26 06:02:27 +03:00
.br
2015-11-13 14:16:08 +02:00
sxhub_get_priv \- Get a private pointer of the links hub
2015-07-26 06:02:27 +03:00
.br
.SH SYNOPSIS
2015-10-27 00:20:44 +02:00
.B #include <sxmp/sxmp.h>
2015-07-26 06:02:27 +03:00
.sp
2015-10-27 00:20:44 +02:00
#define sxhub_set_priv(c, p)
2015-07-26 06:04:42 +03:00
.br
2015-10-27 00:20:44 +02:00
#define sxhub_get_priv(c)
2015-07-26 06:02:27 +03:00
.br
.sp
.SH DESCRIPTION
There macros should be used in case if you want set and get back your private pointer for something.
.br
Pointer is a
.B void*
i.e. it might be anything you pointed in the memory.
.br
2015-10-27 00:20:44 +02:00
.B sxhub_set_priv
2015-07-26 06:02:27 +03:00
will set a pointer
.B p
to connections set
.B c
.br
2015-10-27 00:20:44 +02:00
.B sxhub_get_priv
2015-07-26 06:02:27 +03:00
will return your pointer set to
.B c
2015-11-13 14:16:08 +02:00
hub link.
2015-07-26 06:02:27 +03:00
.br
.SH RETURN VALUE
None in case of
2015-10-27 00:20:44 +02:00
.B sxhub_set_priv
2015-07-26 06:02:27 +03:00
, a private pointer set in case of
2015-10-27 00:20:44 +02:00
.B sxhub_get_priv
2015-07-26 06:02:27 +03:00
.br
.SH ERRORS
None.
.br
.SH BUGS
None known yet.
.SH EXAMPLE
None.
.SH APPLICATION USAGE
None.
.SH RATIONALE
None.
.SH SEE ALSO
2015-10-27 00:20:44 +02:00
.BI sxhub_set_ondestroy(3)
2015-07-26 06:02:27 +03:00
.SH COPYRIGHT
2015-12-29 22:42:52 +02:00
This software licensed under GNU LGPL v3. See COPYING for further details.
2015-07-26 06:02:27 +03:00
.br
(c) Askele Group 2013-2015 <http://askele.com>
.SH AUTHOR
Alexander Vdolainen (vdo@askele.com)