1.3.3.1.6 MAC_COMMON_GetRequestSync Function

C

MAC_STATUS MAC_COMMON_GetRequestSync
(
    MAC_COMMON_PIB_ATTRIBUTE attribute,
    uint16_t index,
    MAC_PIB_VALUE *pibValue
);

Summary

The MAC_COMMON_GetRequestSync primitive gets the value of an attribute in the MAC Common layer Parameter Information Base (PIB).

Description

GetRequestSync primitive is used to get the value of a PIB. Sync suffix indicates that result is provided upon function call return, in the pibValue parameter.

Precondition

MAC_COMMON_Init primitive has to be called before.

Parameters


Param	Description
attribute	Identifier of the Attribute to retrieve value.
index	Index of element in case Attribute is a table. Otherwise index must be set to '0'.
pibValue	Pointer to MAC_PIB_VALUE object where value will be returned.

Returns

Result of get operation as a MAC_STATUS code.

Example

MAC_STATUS status;
MAC_PIB_VALUE value;

status = MAC_COMMON_GetRequestSync(MAC_COMMON_PIB_RC_COORD, 0, &value);
if (status == MAC_STATUS_SUCCESS)
{
    // Get value from 'value' parameter
}

Remarks

None.