NAME

       nbd_set_handle_name - set the handle name

SYNOPSIS

        #include <libnbd.h>

        int nbd_set_handle_name (
              struct nbd_handle *h, const char *handle_name
            );

DESCRIPTION

       Handles have a name which is unique within the current process.  The handle name is used in debug output.

       Handle names are normally generated automatically and have the form "nbd1", "nbd2", etc., but you can
       optionally use this call to give the handles a name which is meaningful for your application to make
       debugging output easier to understand.

RETURN VALUE

       If the call is successful the function returns 0.

ERRORS

       On error -1 is returned.

       Refer to "ERROR HANDLING" in libnbd(3) for how to get further details of the error.

       The following parameters must not be NULL: "h", "handle_name".  For more information see "Non-NULL
       parameters" in libnbd(3).

VERSION

       This function first appeared in libnbd 1.0.

       If you need to test if this function is available at compile time check if the following macro is
       defined:

        #define LIBNBD_HAVE_NBD_SET_HANDLE_NAME 1

SEE ALSO

       nbd_create(3), nbd_get_handle_name(3), libnbd(3).

AUTHORS

       Eric Blake

       Richard W.M. Jones

COPYRIGHT

       Copyright Red Hat

LICENSE

       This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser
       General Public License as published by the Free Software Foundation; either version 2 of the License, or
       (at your option) any later version.

       This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
       the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General
       Public License for more details.

       You should have received a copy of the GNU Lesser General Public License along with this library; if not,
       write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

libnbd-1.20.0                                      2024-04-05                             nbd_set_handle_name(3)