.\" Extracted by src2man from /build/rpma-11eW7Q/rpma-1.3.0/src/include/librpma.h
.\" Text automatically generated by txt2man
.TH rpma_mr_get_descriptor 3 "29 May 2023" "RPMA" "RPMA Programmer's Manual"
.SH NAME
\fBrpma_mr_get_descriptor \fP- get a descriptor of a memory region
.SH SYNOPSIS
.nf
.fam C
      #include <librpma.h>

      struct rpma_mr_local;
      int \fBrpma_mr_get_descriptor\fP(const struct rpma_mr_local *mr, void *desc);

.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
\fBrpma_mr_get_descriptor\fP() writes a network-transferable description of the provided local memory
region (called 'descriptor'). Once the descriptor is transferred to the other side it should be
decoded by \fBrpma_mr_remote_from_descriptor\fP() to create a remote memory region's structure which
allows for Remote Memory Access. Please see \fBlibrpma\fP(7) for details.
.SH SECURITY WARNING
See \fBrpma_mr_remote_from_descriptor\fP(3).
.SH RETURN VALUE
The \fBrpma_mr_get_descriptor\fP() function returns 0 on success or a negative error code on failure.
.SH ERRORS
\fBrpma_mr_get_descriptor\fP() can fail with the following error:
.IP \(bu 3
RPMA_E_INVAL - mr or desc is NULL
.SH SEE ALSO
\fBrpma_mr_get_descriptor_size\fP(3), \fBrpma_mr_reg\fP(3), \fBlibrpma\fP(7) and https://pmem.io/rpma/