---
name: "pmem2_source_get_handle"
section: "3"
platform: "linux"
package: "libpmem2-dev"
version: "1.13.1-1.1+b1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/pmem2_source_get_handle"
---

# pmem2\_source\_get\_handle(3)

reads file handler of the data source

## 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)](/pmem2_source_get_fd/3.md). If the source was created using [**pmem2\_source\_from\_fd**(3)](/pmem2_source_from_fd/3.md) 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)](/pmem2_source_from_fd/3.md) 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_from_fd/3.md), [**pmem2\_source\_get\_fd**(3)](/pmem2_source_get_fd/3.md), [**libpmem2**(7)](/libpmem2/7.md) and **\<https://pmem.io\>**