X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=doc%2Fsrc%2Fman%2Frmr_bytes2payload.3.xfm;h=0f8175683cb236ce7d762f69d5f7022a59fa82ef;hb=HEAD;hp=a8f99e2b1b29a8fc92679cc1f1519410a74b1439;hpb=fd9cc7a5b3355146388ebdf4d558cb284c66c5f1;p=ric-plt%2Flib%2Frmr.git diff --git a/doc/src/man/rmr_bytes2payload.3.xfm b/doc/src/man/rmr_bytes2payload.3.xfm index a8f99e2..0f81756 100644 --- a/doc/src/man/rmr_bytes2payload.3.xfm +++ b/doc/src/man/rmr_bytes2payload.3.xfm @@ -1,7 +1,7 @@ .if false ================================================================================== - Copyright (c) 2019 Nokia - Copyright (c) 2018-2019 AT&T Intellectual Property. + Copyright (c) 2019 Nokia + Copyright (c) 2018-2019 AT&T Intellectual Property. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -18,31 +18,20 @@ .fi .if false - Mnemonic rmr_bytes2payload.xfm - Abstract The manual page for the rmr_bytes2payload function. - Author E. Scott Daniels - Date 8 March 2019 + Mnemonic rmr_bytes2payload.xfm + Abstract The manual page for the rmr_bytes2payload function. + Author E. Scott Daniels + Date 8 March 2019 .fi -.** if formatting with tfm, the roff.im will cause roff output to be generated -.** if formatting with pfm, then pretty postscript will be generated .gv e LIB lib -.if pfm - .im &{lib}/generic_ps.im -.ei - .gv e OUTPUT_RST use_rst - .if .ev &use_rst 1 = - .im &{lib}/rst.im - .ei - .im &{lib}/roff.im - .fi -.fi +.im &{lib}/man/setup.im &line_len(6i) &h1(RMR Library Functions) &h2(NAME) - rmr_bytes2payload + rmr_bytes2payload &h2(SYNOPSIS) &indent @@ -57,9 +46,9 @@ void rmr_bytes2payload( rmr_mbuf_t* mbuf, unsigned char* src, int len ) &h2(DESCRIPTION) This is a convenience function as some wrapper languages might not have the ability to directly copy into the payload buffer. -The bytes from &ital( src ) for the length given are copied to the payload. +The bytes from &ital(src) for the length given are copied to the payload. It is the caller's responsibility to ensure that the payload is large enough. -Upon successfully copy, the &cw( len ) field in the message buffer is updated to +Upon successfully copy, the &cw(len) field in the message buffer is updated to reflect the number of bytes copied. .sp There is little error checking, and no error reporting. @@ -95,7 +84,3 @@ rmr_str2xact(3), rmr_wh_open(3), rmr_wh_send_msg(3) - - -.qu -