1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3 .. CAUTION: this document is generated from source in doc/src/rtd.
4 .. To make changes edit the source and recompile the document.
5 .. Do NOT make changes directly to .rst or .md files.
7 ============================================================================================
9 ============================================================================================
33 char* rmr_get_xact( rmr_mbuf_t* mbuf, unsigned char* dest )
40 The ``rmr_get_xact`` function will copy the transaction field
41 from the message into the *dest* buffer provided by the user.
42 The buffer referenced by *dest* is assumed to be at least
43 ``RMR_MAX_XID`` bytes in length. If *dest* is NULL, then a
44 buffer is allocated (the calling application is expected to
45 free when the buffer is no longer needed).
51 On success, a pointer to the extracted string is returned. If
52 *dest* was supplied, then this is just a pointer to the
53 caller's buffer. If *dest* was NULL, this is a pointer to the
54 allocated buffer. If an error occurs, a nil pointer is
55 returned and errno is set as described below.
61 If an error occurs, the value of the global variable
62 ``errno`` will be set to one of the following with the
72 The message, or an internal portion of the message, was
73 corrupted or the pointer was invalid.
77 A nil pointer was passed for *dest,* however it was not
78 possible to allocate a buffer using malloc().
86 rmr_alloc_msg(3), rmr_bytes2xact(3), rmr_bytes2meid(3),
87 rmr_call(3), rmr_free_msg(3), rmr_get_rcvfd(3),
88 rmr_get_meid(3), rmr_payload_size(3), rmr_send_msg(3),
89 rmr_rcv_msg(3), rmr_rcv_specific(3), rmr_rts_msg(3),
90 rmr_ready(3), rmr_fib(3), rmr_has_str(3), rmr_tokenise(3),
91 rmr_mk_ring(3), rmr_ring_free(3), rmr_str2meid(3),
92 rmr_str2xact(3), rmr_wh_open(3), rmr_wh_send_msg(3)