HPX - High Performance ParalleX

PrevUpHomeNext

Function unregister_id_with_basename

hpx::unregister_id_with_basename — Unregister the given id using the given base name.

Synopsis

// In header: <hpx/hpx_fwd.hpp>


hpx::future< hpx::id_type > 
unregister_id_with_basename(char const * base_name, 
                            std::size_t sequence_nr = ~0U);

Description

The function unregisters the given ids using the provided base name.

Parameters:

base_name

[in] The base name for which to retrieve the registered ids.

sequence_nr

[in, optional] The sequential number to use for the un-registration. This number has to be the same as has been used with register_id_with_basename before.

Returns:

A future representing the result of the un-registration operation itself.


PrevUpHomeNext