1.5.4.21 AL_GetRequest Function

C

AL_RESULT AL_GetRequest (
        AL_IB_ATTRIBUTE attribute,
        uint16_t index,
        AL_IB_VALUE *ibValue
);

Summary

The AL_GetRequest primitive gets the value of an attribute in the AL layer Parameter Information Base (IB).

Description

GetRequest primitive is used to get the value of an IB.

Result is provided upon function call return, in the ibValue parameter.

Parameters

Param	Description
attribute	Identifier of the Attribute to retrieve value. See AL_IB_ATTRIBUTE Enum
index	Index of element in case Attribute is a table. Otherwise index must be set to '0'
ibValue	Pointer to AL_IB_VALUE object where value will be returned. See AL_IB_VALUE Struct

Returns

Result of get operation as a AL_RESULT Enum.

Example

    AL_RESULT result;
    AL_IB_VALUE value;
    result = AL_GetRequest(AL_AUTH_LMON_IB, 0, &value);
    if (result == AL_RESULT_SUCCESS)
    {
        /* Read value */
    }

Remarks

None.