1nbd_get_handle_name(3) LIBNBD nbd_get_handle_name(3)
2
3
4
6 nbd_get_handle_name - get the handle name
7
9 #include <libnbd.h>
10
11 char * nbd_get_handle_name (struct nbd_handle *h);
12
14 Get the name of the handle. If it was previously set by calling
15 nbd_set_handle_name(3) then this returns the name that was set.
16 Otherwise it will return a generic name like "nbd1", "nbd2", etc.
17
19 This call returns a string. The caller must free the returned string
20 to avoid a memory leak.
21
23 On error "NULL" is returned.
24
25 Refer to "ERROR HANDLING" in libnbd(3) for how to get further details
26 of the error.
27
29 This function first appeared in libnbd 1.0.
30
31 If you need to test if this function is available at compile time check
32 if the following macro is defined:
33
34 #define LIBNBD_HAVE_NBD_GET_HANDLE_NAME 1
35
37 nbd_create(3), nbd_set_handle_name(3), libnbd(3).
38
40 Eric Blake
41
42 Richard W.M. Jones
43
45 Copyright (C) 2019-2021 Red Hat Inc.
46
48 This library is free software; you can redistribute it and/or modify it
49 under the terms of the GNU Lesser General Public License as published
50 by the Free Software Foundation; either version 2 of the License, or
51 (at your option) any later version.
52
53 This library is distributed in the hope that it will be useful, but
54 WITHOUT ANY WARRANTY; without even the implied warranty of
55 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
56 Lesser General Public License for more details.
57
58 You should have received a copy of the GNU Lesser General Public
59 License along with this library; if not, write to the Free Software
60 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
61 02110-1301 USA
62
63
64
65libnbd-1.7.12 2021-05-29 nbd_get_handle_name(3)