1.3.4.1.7 MAC_PLC_SetRequestSync Function

C

MAC_STATUS MAC_PLC_SetRequestSync
(
    MAC_PLC_PIB_ATTRIBUTE attribute,
    uint16_t index,
    const MAC_PIB_VALUE *pibValue
);

Summary

The MAC_PLC_SetRequestSync primitive sets the value of an attribute in the MAC PLC layer Parameter Information Base (PIB).

Description

SetRequestSync primitive is used to set the value of a PIB. Sync suffix indicates that result of set operation is provided upon function call return, in the return status code.

Precondition

MAC_PLC_Init routine must have been called before.

Parameters

ParamDescription
attributeIdentifier of the Attribute to provide value. See MAC_PLC_PIB_ATTRIBUTE
indexIndex of element in case Attribute is a table. Otherwise index must be set to '0'
pibValuePointer to MAC_PIB_VALUE object where value is contained

Returns

Result of set operation as a MAC_STATUS code.

Example

MAC_STATUS status;
const MAC_PIB_VALUE value = {
    .length = 1,
    .value = 6
};

status = MAC_PLC_SetRequestSync(MAC_PIB_MAX_FRAME_RETRIES, 0, &value);
if (status == MAC_STATUS_SUCCESS)
{
    // PIB correctly set
}

Remarks

None.