docs/rmr_get_meid.3.rst

   1
   2
   3 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   4 .. SPDX-License-Identifier: CC-BY-4.0
   5 .. CAUTION: this document is generated from source in doc/src/rtd.
   6 .. To make changes edit the source and recompile the document.
   7 .. Do NOT make changes directly to .rst or .md files.
   8
   9
  10 ============================================================================================
  11 Man Page: rmr_get_meid
  12 ============================================================================================
  13
  14 RMR Library Functions
  15 ============================================================================================
  16
  17
  18 NAME
  19 --------------------------------------------------------------------------------------------
  20
  21 rmr_get_meid
  22
  23 SYNOPSIS
  24 --------------------------------------------------------------------------------------------
  25
  26
  27 ::
  28
  29  #include <rmr/rmr.h>
  30  char* rmr_get_meid( rmr_mbuf_t* mbuf, unsigned char* dest )
  31
  32
  33
  34 DESCRIPTION
  35 --------------------------------------------------------------------------------------------
  36
  37 The rmr_get_meid function will copy the managed entity ID
  38 (meid) field from the message into the *dest* buffer provided
  39 by the user. The buffer referenced by *dest* is assumed to be
  40 at least RMR_MAX_MEID bytes in length. If *dest* is NULL,
  41 then a buffer is allocated (the calling application is
  42 expected to free when the buffer is no longer needed).
  43
  44 RETURN VALUE
  45 --------------------------------------------------------------------------------------------
  46
  47 On success, a pointer to the extracted string is returned. If
  48 *dest* was supplied, then this is just a pointer to the
  49 caller's buffer. If *dest* was NULL, this is a pointer to the
  50 allocated buffer. If an error occurs, a nil pointer is
  51 returned and errno is set as described below.
  52
  53 ERRORS
  54 --------------------------------------------------------------------------------------------
  55
  56 If an error occurs, the value of the global variable errno
  57 will be set to one of the following with the indicated
  58 meaning.
  59
  60
  61
  62 EINVAL
  63
  64   The message, or an internal portion of the message, was
  65   corrupted or the pointer was invalid.
  66
  67
  68 ENOMEM
  69
  70   A nil pointer was passed for *dest,* however it was not
  71   possible to allocate a buffer using malloc().
  72
  73
  74 SEE ALSO
  75 --------------------------------------------------------------------------------------------
  76
  77 rmr_alloc_msg(3), rmr_bytes2xact(3), rmr_bytes2meid(3),
  78 rmr_call(3), rmr_free_msg(3), rmr_get_rcvfd(3),
  79 rmr_get_xact(3), rmr_payload_size(3), rmr_send_msg(3),
  80 rmr_rcv_msg(3), rmr_rcv_specific(3), rmr_rts_msg(3),
  81 rmr_ready(3), rmr_fib(3), rmr_has_str(3), rmr_tokenise(3),
  82 rmr_mk_ring(3), rmr_ring_free(3), rmr_str2meid(3),
  83 rmr_str2xact(3), rmr_wh_open(3), rmr_wh_send_msg(3)