nbd_set_debug - Man Page

set or clear the debug flag

Synopsis

 #include <libnbd.h>

 int nbd_set_debug (
       struct nbd_handle *h, bool debug
     );

Description

Set or clear the debug flag.  When debugging is enabled, debugging messages from the library are printed to stderr, unless a debugging callback has been defined too (see nbd_set_debug_callback(3)) in which case they are sent to that function.  This flag defaults to false on newly created handles, except if LIBNBD_DEBUG=1 is set in the environment in which case it defaults to true.

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. 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_DEBUG 1

See Also

nbd_create(3), nbd_set_debug_callback(3), nbd_set_handle_name(3), libnbd(3).

Authors

Eric Blake

Richard W.M. Jones

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

Referenced By

libnbd(3), nbdcopy(1), nbd_get_debug(3).

2024-10-14 libnbd-1.21.6