nbdkit_export_name3

Usage

 #include <nbdkit-plugin.h>
 const char *nbdkit_export_name (void);

Overview

Return the optional NBD export name if one was negotiated with the current client (this uses thread-local magic so no parameter is required).

The export name is a free-form text string, it is not necessarily a path or filename and it does not need to begin with a '/' character. The NBD protocol describes the empty string ("") as a representing a "default export" or to be used in cases where the export name does not make sense.

The export name is untrusted client data, be cautious when parsing it.

Return value

The function returns a string. The returned string is valid at least through the ".close" of the current connection, but if you need to store it in the plugin for use by more than one client you must copy it.

If there is an error it calls nbdkit_error(3) and returns "NULL".

Language bindings

In nbdkit-ocaml-plugin(3):

 NBDKit.export_name : unit -> string

In nbdkit-python-plugin(3):

 import nbdkit
 name = nbdkit.export_name()

In nbdkit-rust-plugin(3):

 use nbdkit::*;
 pub fn export_name() -> std::result::Result<String, Box<dyn error::Error>>

In nbdkit-sh-plugin(3) the export name is available as parameter $3 of the "open" method.