3 ==================================================================================
4 Copyright (c) 2019 Nokia
5 Copyright (c) 2018-2019 AT&T Intellectual Property.
7 Licensed under the Apache License, Version 2.0 (the "License");
8 you may not use this file except in compliance with the License.
9 You may obtain a copy of the License at
11 http://www.apache.org/licenses/LICENSE-2.0
13 Unless required by applicable law or agreed to in writing, software
14 distributed under the License is distributed on an "AS IS" BASIS,
15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 See the License for the specific language governing permissions and
17 limitations under the License.
18 ==================================================================================
22 Mnemonic rmr_str2xact.xfm
23 Abstract The manual page for the rmr_str2xact function.
24 Author E. Scott Daniels
28 .** if formatting with tfm, the roff.im will cause roff output to be generated
29 .** if formatting with pfm, then pretty postscript will be generated
32 .im &{lib}/generic_ps.im
34 .gv e OUTPUT_RST use_rst
44 &h1(RMR Library Functions)
53 int rmr_str2xact( rmr_mbuf_t* mbuf, unsigned char* src, int len )
59 The &cw(rmr_str2xact) function will copy the string pointed to by src to the
60 transaction ID (xaction) field in the given message.
61 The field is a fixed length, gated by the constant &cw(RMR_MAX_XID) and if string length is larger
62 than this value, then &bold(nothing) will be copied. (Note, this differs slightly from the
63 behaviour of the &cw( lrmr_bytes2xact() ) function.)
65 &beg_dlist(.75i : ^&bold_font )
67 On success, the value RMR_OK is returned.
68 If the string cannot be copied to the message, the return value will be one of the
72 If the return value is not RMR_OK, then it will be set to one of the values below.
75 &di(RMR_ERR_BADARG) The message, or an internal portion of the message, was corrupted or the pointer was invalid.
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.