doc/src/man/rmr_str2meid.3.xfm

   1 .if false
   2 ==================================================================================
   3         Copyright (c) 2019 Nokia
   4         Copyright (c) 2018-2019 AT&T Intellectual Property.
   5
   6    Licensed under the Apache License, Version 2.0 (the "License");
   7    you may not use this file except in compliance with the License.
   8    You may obtain a copy of the License at
   9
  10        http://www.apache.org/licenses/LICENSE-2.0
  11
  12    Unless required by applicable law or agreed to in writing, software
  13    distributed under the License is distributed on an "AS IS" BASIS,
  14    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15    See the License for the specific language governing permissions and
  16    limitations under the License.
  17 ==================================================================================
  18 .fi
  19
  20 .if false
  21         Mnemonic        rmr_str2meid.xfm
  22         Abstract        The manual page for the rmr_str2meid function.
  23         Author          E. Scott Daniels
  24         Date            8 March 2019
  25 .fi
  26
  27 .** if formatting with tfm, the roff.im will cause roff output to be generated
  28 .** if formatting with pfm, then pretty postscript will be generated
  29 .gv e LIB lib
  30 .if pfm
  31         .im &{lib}/generic_ps.im
  32 .ei
  33         .gv e OUTPUT_RST use_rst
  34         .if .ev &use_rst 1 =
  35                 .im &{lib}/rst.im
  36         .ei
  37                 .im &{lib}/roff.im
  38         .fi
  39 .fi
  40
  41 &line_len(6i)
  42
  43 &h1(RMR Library Functions)
  44 &h2(NAME)
  45         rmr_str2meid
  46
  47 &h2(SYNOPSIS)
  48 &indent
  49 &ex_start
  50 #include <rmr/rmr.h>
  51
  52 int rmr_str2meid( rmr_mbuf_t* mbuf, unsigned char* src, int len )
  53 &ex_end
  54
  55 &uindent
  56
  57 &h2(DESCRIPTION)
  58 The &cw(rmr_str2meid) function will copy the string pointed to by src to the
  59 managed equipment ID (meid) field in the given message.
  60 The field is a fixed length, gated by the constant &cw(RMR_MAX_MEID) and if string length is larger
  61 than this value, then &bold(nothing) will be copied. (Note, this differs slightly from the
  62 behaviour of the &cw( lrmr_bytes2meid() ) function.)
  63
  64 &h2(RETURN VALUE)
  65 On success, the value RMR_OK is returned.
  66 If the string cannot be copied to the message, the return value will be one of the
  67 errors listed below.
  68
  69 &h2(ERRORS)
  70 If the return value is not RMR_OK, then it will be set to one of the values below.
  71 &half_space
  72
  73
  74 &beg_dlist(.75i : ^&bold_font )
  75 &di(RMR_ERR_BADARG) The message, or an internal portion of the message, was corrupted or the pointer was invalid.
  76
  77 &half_space
  78 &di(RMR_ERR_OVERFLOW) The length passed in was larger than the maximum length of the field; only a portion of
  79         the source bytes were copied.
  80 &end_dlist
  81
  82 &h2(EXAMPLE)
  83
  84
  85 &h2(SEE ALSO )
  86 .ju off
  87 rmr_alloc_msg(3),
  88 rmr_call(3),
  89 rmr_free_msg(3),
  90 rmr_get_meid(3),
  91 rmr_get_rcvfd(3),
  92 rmr_payload_size(3),
  93 rmr_send_msg(3),
  94 rmr_rcv_msg(3),
  95 rmr_rcv_specific(3),
  96 rmr_rts_msg(3),
  97 rmr_ready(3),
  98 rmr_fib(3),
  99 rmr_has_str(3),
 100 rmr_tokenise(3),
 101 rmr_mk_ring(3),
 102 rmr_ring_free(3),
 103 rmr_bytes2meid(3),
 104 rmr_wh_open(3),
 105 rmr_wh_send_msg(3)
 106 .ju on
 107 .qu
 108