Man Page: rmr_str2meid¶

RMR LIBRARY FUNCTIONS¶

NAME¶

rmr_str2meid

SYNOPSIS¶

#include <rmr/rmr.h>

int rmr_str2meid( rmr_mbuf_t* mbuf, unsigned char* src, int len )

DESCRIPTION¶

The rmr_str2meid function will copy the string pointed to by src to the managed entity ID (meid) field in the given message. The field is a fixed length, gated by the constant RMR_MAX_MEID and if string length is larger than this value, then nothing will be copied. (Note, this differs slightly from the behaviour of the lrmr_bytes2meid() function.)

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 errors listed below.

ERRORS¶

If the return value is not RMR_OK, then it will be set to one of the values below.

RMR_ERR_BADARG

The message, or an internal portion of the message, was corrupted or the pointer was invalid.

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.