Man page - pmem2_source_get_handle(3)
Packages contains this manual
- pmem2_get_memset_fn(3)
- pmem2_map_delete(3)
- pmem2_source_get_fd(3)
- pmem2_vm_reservation_map_find_prev(3)
- pmem2_source_from_handle(3)
- pmem2_vm_reservation_get_address(3)
- pmem2_config_set_vm_reservation(3)
- pmem2_source_device_id(3)
- pmem2_badblock_clear(3)
- pmem2_async(3)
- pmem2_vm_reservation_map_find_first(3)
- pmem2_vm_reservation_map_find_last(3)
- pmem2_map_from_existing(3)
- pmem2_config_new(3)
- pmem2_badblock_context_new(3)
- pmem2_deep_flush(3)
- pmem2_memcpy_async(3)
- pmem2_source_delete(3)
- pmem2_source_pread_mcsafe(3)
- pmem2_vm_reservation_extend(3)
- pmem2_source_alignment(3)
- pmem2_config_set_sharing(3)
- pmem2_badblock_next(3)
- pmem2_badblock_context_delete(3)
- pmem2_source_numa_node(3)
- pmem2_vm_reservation_shrink(3)
- pmem2_config_set_length(3)
- pmem2_source_size(3)
- pmem2_vm_reservation_map_find_next(3)
- pmem2_vm_reservation_new(3)
- pmem2_map_get_size(3)
- pmem2_config_set_required_store_granularity(3)
- pmem2_source_from_fd(3)
- pmem2_get_memmove_fn(3)
- pmem2_get_flush_fn(3)
- pmem2_vm_reservation_get_size(3)
- pmem2_memset_async(3)
- pmem2_map_get_address(3)
- pmem2_get_drain_fn(3)
- pmem2_memmove_async(3)
- pmem2_perror(3)
- pmem2_errormsg(3)
- pmem2_config_set_protection(3)
- pmem2_source_device_usc(3)
- pmem2_config_delete(3)
- pmem2_config_set_vdm(3)
- pmem2_get_persist_fn(3)
- pmem2_vm_reservation_delete(3)
- pmem2_map_new(3)
- pmem2_source_from_anon(3)
- libpmem2_unsafe_shutdown(7)
- pmem2_source_get_handle(3)
- pmem2_vm_reservation_map_find(3)
- pmem2_get_memcpy_fn(3)
- libpmem2(7)
- pmem2_config_set_offset(3)
- pmem2_source_pwrite_mcsafe(3)
- pmem2_map_get_store_granularity(3)
apt-get install libpmem2-dev
Manual
NAME
SYNOPSIS
DESCRIPTION
ERRORS
RETURN VALUE
SEE ALSO
NAME
pmem2_source_get_handle () - reads file handler of the data source
SYNOPSIS
#include <libpmem2.h> int pmem2_source_get_handle(const struct pmem2_source *src, HANDLE *h);
DESCRIPTION
The pmem2_source_get_handle () function reads the file handler of *struct pmem2_source** object describing the data source and returns it by h parameter.
This function is Windows only, on Linux use pmem2_source_get_fd (3). If the source was created using pmem2_source_from_fd (3) then pmem2_source_get_handle () is also valid function to read handler, because file descriptor is converted to file handle during source creation.
However, there are limitations to what you can do with a handle created from a file descriptor. For details refer to DESCRIPTION section in the pmem2_source_from_fd (3) manpage.
ERRORS
The pmem2_source_get_handle () can fail with the following errors:
|
• |
PMEM2_E_FILE_HANDLE_NOT_SET - in case of an instance of struct pmem2_source that does not come from source type that support file handles, eg. anonymous data source. |
RETURN VALUE
The pmem2_source_get_handle () returns a file handle of data source.
SEE ALSO
pmem2_source_from_fd (3), pmem2_source_get_fd (3), libpmem2 (7) and <https://pmem.io>