nbd_get_handle_name3

Usage

 #include <libnbd.h>
 char * nbd_get_handle_name (
          struct nbd_handle *h
        );

Overview

Get the name of the handle. If it was previously set by calling nbd_set_handle_name(3) then this returns the name that was set. Otherwise it will return a generic name like "nbd1", "nbd2", etc.

Return value

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

Errors

On error "NULL" 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_GET_HANDLE_NAME 1