Man Page: rmr_get_meid

RMR LIBRARY FUNCTIONS

NAME

rmr_get_meid

SYNOPSIS

#include <rmr/rmr.h>

char* rmr_get_meid( rmr_mbuf_t* mbuf, unsigned char* dest )

DESCRIPTION

The rmr_get_meid function will copy the managed entity ID (meid) field from the message into the dest buffer provided by the user. The buffer referenced by dest is assumed to be at least RMR_MAX_MEID bytes in length. If dest is NULL, then a buffer is allocated (the calling application is expected to free when the buffer is no longer needed).

RETURN VALUE

On success, a pointer to the extracted string is returned. If dest was supplied, then this is just a pointer to the caller’s buffer. If dest was NULL, this is a pointer to the allocated buffer. If an error occurs, a nil pointer is returned and errno is set as described below.

ERRORS

If an error occurs, the value of the global variable errno will be set to one of the following with the indicated meaning.

EINVAL

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

ENOMEM

A nil pointer was passed for dest, however it was not possible to allocate a buffer using malloc().