Since: HDF5 1.14.0
H5Iregister_future
fn
hid_t H5Iregister_future(H5I_type_t type, const void * object,
H5I_future_realize_func_t realize_cb, H5I_future_discard_func_t discard_cb)Registers a "future" object and returns a new identifier for it.
Creates and returns a new ID for a "future" object. Future objects are placeholders for objects that have not yet been created or opened. This is primarily used by VOL connectors for asynchronous operations.
When the future object is accessed, the realize_cb callback is invoked to convert it to an actual object. If the future object is discarded without being realized, the discard_cb callback is invoked.
Parameters
type | The identifier type |
object | Pointer to the future object to register |
realize_cb | Callback to realize the future object |
discard_cb | Callback to discard the future object |
Returns
A new identifier on success, or H5I_INVALID_HID on failure.