1nbd_set_handle_name(3)              LIBNBD              nbd_set_handle_name(3)
2
3
4

NAME

6       nbd_set_handle_name - set the handle name
7

SYNOPSIS

9        #include <libnbd.h>
10
11        int nbd_set_handle_name (struct nbd_handle *h,
12                                 const char *handle_name);
13

DESCRIPTION

15       Handles have a name which is unique within the current process.  The
16       handle name is used in debug output.
17
18       Handle names are normally generated automatically and have the form
19       "nbd1", "nbd2", etc., but you can optionally use this call to give the
20       handles a name which is meaningful for your application to make
21       debugging output easier to understand.
22

RETURN VALUE

24       If the call is successful the function returns 0.
25

ERRORS

27       On error "-1" is returned.
28
29       Refer to "ERROR HANDLING" in libnbd(3) for how to get further details
30       of the error.
31

VERSION

33       This function first appeared in libnbd 1.0.
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_HANDLE_NAME 1
39

SEE ALSO

41       nbd_create(3), nbd_get_handle_name(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.10.1                     2021-10-25            nbd_set_handle_name(3)
Impressum