X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=doc%2Fsrc%2Fman%2Frmr_str2xact.3.xfm;h=0eab5a9c7c3d2835b85b99f6d36fd030e4c649fe;hb=d07cc97b4b5493a5fc67231ee09d1c931c993161;hp=6bc40d094867ee42f769b07890470b987510f9f9;hpb=3ca996aaf32fe37d727b29d6fb88354365988561;p=ric-plt%2Flib%2Frmr.git diff --git a/doc/src/man/rmr_str2xact.3.xfm b/doc/src/man/rmr_str2xact.3.xfm index 6bc40d0..0eab5a9 100644 --- a/doc/src/man/rmr_str2xact.3.xfm +++ b/doc/src/man/rmr_str2xact.3.xfm @@ -1,8 +1,7 @@ - .if false ================================================================================== - Copyright (c) 2019 Nokia - Copyright (c) 2018-2019 AT&T Intellectual Property. + Copyright (c) 2019-2020 Nokia + Copyright (c) 2018-2020 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. @@ -19,20 +18,20 @@ .fi .if false - Mnemonic rmr_str2xact.xfm - Abstract The manual page for the rmr_str2xact function. - Author E. Scott Daniels - Date 8 March 2019 + Mnemonic rmr_str2xact.xfm + Abstract The manual page for the rmr_str2xact function. + Author E. Scott Daniels + Date 8 March 2019 .fi .gv e LIB lib -.im &{lib}/man/setup.im +.im &{lib}/man/setup.im &line_len(6i) &h1(RMR Library Functions) &h2(NAME) - rmr_str2xact + rmr_str2xact &h2(SYNOPSIS) &indent @@ -45,26 +44,24 @@ int rmr_str2xact( rmr_mbuf_t* mbuf, unsigned char* src, int len ) &uindent &h2(DESCRIPTION) -The &cw(rmr_str2xact) function will copy the string pointed to by src to the -transaction ID (xaction) field in the given message. +The &cw(rmr_str2xact) function will copy the string pointed to by src to the +transaction ID (xaction) field in the given message. The field is a fixed length, gated by the constant &cw(RMR_MAX_XID) and if string length is larger than this value, then &bold(nothing) will be copied. (Note, this differs slightly from the -behaviour of the &cw( lrmr_bytes2xact() ) function.) +behaviour of the &cw(lrmr_bytes2xact()) function.) -&beg_dlist(.75i : ^&bold_font ) &h2(RETURN VALUE) -On success, the value RMR_OK is returned. -If the string cannot be copied to the message, the return value will be one of the +On success, the value RMR_OK is returned. +If the string cannot be copied to the message, the return value will be one of the errors listed below. &h2(ERRORS) If the return value is not RMR_OK, then it will be set to one of the values below. -&half_space -&di(RMR_ERR_BADARG) The message, or an internal portion of the message, was corrupted or the pointer was invalid. +&beg_dlist(.75i : ^&bold_font ) + &ditem(RMR_ERR_BADARG) The message, or an internal portion of the message, was corrupted or the pointer was invalid. -&half_space -&di(RMR_ERR_OVERFLOW) The length passed in was larger than the maximum length of the field; only a portion of + &ditem(RMR_ERR_OVERFLOW) The length passed in was larger than the maximum length of the field; only a portion of the source bytes were copied. &end_dlist @@ -72,12 +69,15 @@ If the return value is not RMR_OK, then it will be set to one of the values belo &h2(SEE ALSO ) +.ju off rmr_alloc_msg(3), rmr_bytes2meid(3), rmr_bytes2xact(3), rmr_call(3), rmr_free_msg(3), +rmr_get_meid(3), rmr_get_rcvfd(3), +rmr_get_xact(3), rmr_payload_size(3), rmr_send_msg(3), rmr_rcv_msg(3), @@ -92,5 +92,5 @@ rmr_ring_free(3), rmr_str2meid(3), rmr_wh_open(3), rmr_wh_send_msg(3) -.qu +.ju on