X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;ds=sidebyside;f=doc%2Fsrc%2Fman%2Frmr_str2xact.3.xfm;h=0c7c2526a712cea078a9de49ed38379074c74cfc;hb=0f231bf2bf5520a418156c965c669e411875dcf0;hp=1f14cd6a48c39a644b5f19e8139f37c737c6457e;hpb=fd9cc7a5b3355146388ebdf4d558cb284c66c5f1;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 1f14cd6..0c7c252 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 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. @@ -19,31 +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 -.** 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_str2xact + rmr_str2xact &h2(SYNOPSIS) &indent @@ -56,16 +44,16 @@ 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) @@ -76,19 +64,22 @@ If the return value is not RMR_OK, then it will be set to one of the values belo &half_space &di(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. + the source bytes were copied. &end_dlist &h2(EXAMPLE) &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), @@ -103,5 +94,5 @@ rmr_ring_free(3), rmr_str2meid(3), rmr_wh_open(3), rmr_wh_send_msg(3) -.qu +.ju on