ot::Spinel::Buffer::InFrameOverwrite() method

Overwrites the previously written content in the current input frame at a given write position. The write position @p aPostion must belong to the same input frame saved earlier with `InFrameGetPosition()`. Does not allow writing beyond the current end of the input frame (i.e., it can only write over previously added content). If writing @p aDataBufferLength bytes from write position @p aPosition goes beyond the end, this method does not change the input frame and returns error status `OT_ERROR_INVALID_ARGS`. Cannot be used if the input frame has an added `otMessage` (i.e., a previous call to `InFrameFeedMessage()`).

Syntax

Show:

Summary

Declaration

Definition

from spinel_buffer.hpp:250

otError InFrameOverwrite(const WritePosition &aPosition, const uint8_t *aDataBuffer, uint16_t aDataBufferLength);

Implemented in spinel_buffer.cpp:433

Arguments

Argument

Description

aPosition

A reference to the write position.

aDataBuffer

A pointer to data buffer.

aDataBufferLength

The length of the data buffer.

Return value

OT_ERROR_NONE Successfully overwrote the data at the given write position. OT_ERROR_INVALID_STATE No input frame (`InFrameBegin()` has not been called). OT_ERROR_INVALID_ARGS The given write position is not valid (i.e., if it does not belong to same input frame), or the input frame has an added `otMessage`, or the write operation will go beyond the current end of the input frame.