X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Frmr_bytes2meid.3.rst;h=3afe3dc9b132fbfc8af98e7cd2fd0b000d62d945;hb=refs%2Fchanges%2F52%2F3652%2F11;hp=b44e0833f80be4081e3ad04843a1d8e13ed1a8d9;hpb=5a9d175bb17fcc71aa19fc23458e485830b97e0a;p=ric-plt%2Flib%2Frmr.git diff --git a/docs/rmr_bytes2meid.3.rst b/docs/rmr_bytes2meid.3.rst index b44e083..3afe3dc 100644 --- a/docs/rmr_bytes2meid.3.rst +++ b/docs/rmr_bytes2meid.3.rst @@ -1,81 +1,93 @@ - - .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 .. CAUTION: this document is generated from source in doc/src/rtd. .. To make changes edit the source and recompile the document. .. Do NOT make changes directly to .rst or .md files. - ============================================================================================ Man Page: rmr_bytes2meid ============================================================================================ -RMR Library Functions -============================================================================================ - - -NAME --------------------------------------------------------------------------------------------- + + +RMR LIBRARY FUNCTIONS +===================== + + + +NAME +---- + rmr_bytes2meid - -SYNOPSIS --------------------------------------------------------------------------------------------- - + + +SYNOPSIS +-------- + :: - + #include + int rmr_bytes2meid( rmr_mbuf_t* mbuf, unsigned char* src, int len ) - - -DESCRIPTION --------------------------------------------------------------------------------------------- - -The rmr_bytes2meid function will copy up to *len* bytes from -*src* to the managed entity ID (meid) field in the message. -The field is a fixed length, gated by the constant -RMR_MAX_MEID and if len is larger than this value, only + + +DESCRIPTION +----------- + +The ``rmr_bytes2meid`` function will copy up to *len* bytes +from *src* to the managed entity ID (meid) field in the +message. The field is a fixed length, gated by the constant +``RMR_MAX_MEID`` and if len is larger than this value, only RMR_MAX_MEID bytes will actually be copied. - -RETURN VALUE --------------------------------------------------------------------------------------------- - + + +RETURN VALUE +------------ + On success, the actual number of bytes copied is returned, or -1 to indicate a hard error. If the length is less than 0, or -not the same as length passed in, errno is set to one of the -errors described in the *Errors* section. - -ERRORS --------------------------------------------------------------------------------------------- - +not the same as length passed in, ``errno`` is set to one of +the errors described in the *Errors* section. + + +ERRORS +------ + If the returned length does not match the length passed in, -errno will be set to one of the following constants with the -meaning listed below. - - - -EINVAL - - The message, or an internal portion of the message, was - corrupted or the pointer was invalid. - - -EOVERFLOW - - The length passed in was larger than the maximum length of - the field; only a portion of the source bytes were copied. - - -EXAMPLE --------------------------------------------------------------------------------------------- - - -SEE ALSO --------------------------------------------------------------------------------------------- - +``errno`` will be set to one of the following constants with +the meaning listed below. + + .. list-table:: + :widths: auto + :header-rows: 0 + :class: borderless + + + * - **EINVAL** + - + The message, or an internal portion of the message, was + corrupted or the pointer was invalid. + + + * - **EOVERFLOW** + - + The length passed in was larger than the maximum length of + the field; only a portion of the source bytes were copied. + + + + +EXAMPLE +------- + + + +SEE ALSO +-------- + rmr_alloc_msg(3), rmr_bytes2xact(3), rmr_call(3), rmr_free_msg(3), rmr_get_rcvfd(3), rmr_get_meid(3), rmr_payload_size(3), rmr_send_msg(3), rmr_rcv_msg(3),