1nbd_set_private_data(3)             LIBNBD             nbd_set_private_data(3)
2
3
4

NAME

6       nbd_set_private_data - set the per-handle private data
7

SYNOPSIS

9        #include <libnbd.h>
10
11        uintptr_t nbd_set_private_data (struct nbd_handle *h,
12                                        uintptr_t private_data);
13

DESCRIPTION

15       Handles contain a private data field for applications to use for any
16       purpose.
17
18       When calling libnbd from C, the type of this field is "uintptr_t" so it
19       can be used to store an unsigned integer or a pointer.
20
21       In non-C bindings it can be used to store an unsigned integer.
22
23       This function sets the value of this field and returns the old value
24       (or 0 if it was not previously set).
25

RETURN VALUE

27       This call returns a "uintptr_t".
28

ERRORS

30       This function does not fail.
31

VERSION

33       This function first appeared in libnbd 1.8.
34
35       If you need to test if this function is available at compile time check
36       if the following macro is defined:
37
38        #define LIBNBD_HAVE_NBD_SET_PRIVATE_DATA 1
39

SEE ALSO

41       nbd_create(3), nbd_get_private_data(3), libnbd(3).
42

AUTHORS

44       Eric Blake
45
46       Richard W.M. Jones
47

49       Copyright (C) 2019-2021 Red Hat Inc.
50

LICENSE

52       This library is free software; you can redistribute it and/or modify it
53       under the terms of the GNU Lesser General Public License as published
54       by the Free Software Foundation; either version 2 of the License, or
55       (at your option) any later version.
56
57       This library is distributed in the hope that it will be useful, but
58       WITHOUT ANY WARRANTY; without even the implied warranty of
59       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
60       Lesser General Public License for more details.
61
62       You should have received a copy of the GNU Lesser General Public
63       License along with this library; if not, write to the Free Software
64       Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
65       02110-1301 USA
66
67
68
69libnbd-1.12.5                     2022-07-10           nbd_set_private_data(3)
Impressum