1nbd_get_handle_name(3)              LIBNBD              nbd_get_handle_name(3)
2
3
4

NAME

6       nbd_get_handle_name - get the handle name
7

SYNOPSIS

9        #include <libnbd.h>
10
11        char * nbd_get_handle_name (struct nbd_handle *h);
12

DESCRIPTION

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

RETURN VALUE

19       This call returns a string.  The caller must free the returned string
20       to avoid a memory leak.
21

ERRORS

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
28       The following parameters must not be NULL: "h".  For more information
29       see "Non-NULL parameters" in libnbd(3).
30

VERSION

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

SEE ALSO

40       nbd_create(3), nbd_set_handle_name(3), libnbd(3).
41

AUTHORS

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

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

LICENSE

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