From e7ece50f08cba4e30cdc770d40735579b13426d0 Mon Sep 17 00:00:00 2001 From: Michael Zillgith Date: Thu, 19 Sep 2019 07:00:56 +0200 Subject: [PATCH] - updated documentation for MMS octet string type (MMS_OCTET_STRING) handling functions --- src/mms/inc/mms_value.h | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/mms/inc/mms_value.h b/src/mms/inc/mms_value.h index bb21bb0f..97c1a944 100644 --- a/src/mms/inc/mms_value.h +++ b/src/mms/inc/mms_value.h @@ -544,7 +544,7 @@ MmsValue_getBinaryTimeAsUtcMs(const MmsValue* self); * * This method will copy the provided buffer to the internal buffer of the * MmsValue instance. This will only happen if the internal buffer size is large - * enough for the new value. + * enough for the new value. Otherwise the object value is not changed. * * \param self MmsValue instance to operate on. Has to be of a type MMS_OCTET_STRING. * \param buf the buffer that contains the new value @@ -556,6 +556,9 @@ MmsValue_setOctetString(MmsValue* self, uint8_t* buf, int size); /** * \brief Returns the size in bytes of an MmsValue object of type MMS_OCTET_STRING. * + * NOTE: To access the byte in the buffer the function \ref MmsValue_getOctetStringBuffer + * has to be used. + * * \param self MmsValue instance to operate on. Has to be of a type MMS_OCTET_STRING. * * \return size in bytes @@ -579,6 +582,8 @@ MmsValue_getOctetStringMaxSize(MmsValue* self); /** * \brief Returns the reference to the internally hold buffer of an MmsValue object of type MMS_OCTET_STRING. * + * NOTE: The size of the buffer can be requested with the \ref MmsValue_getOctetStringSize function. + * * \param self MmsValue instance to operate on. Has to be of a type MMS_OCTET_STRING. * * \return reference to the buffer