1.2.5.31 ADP_GetRequestSync Function

C

void ADP_GetRequestSync (
    uint32_t attributeId,
    uint16_t attributeIndex,
    ADP_GET_CFM_PARAMS* pGetConfirm
);

Summary

This primitive gets the value of an attribute from the ADP information base synchronously.

Description

The ADP Get Request primitive allows the upper layer to get the value of an attribute from the ADP information base synchronously. Result is provided directly in one of the function call parameters.

Parameters

ParamDescription
attributeIdThe identifier of the ADP IB attribute to read. See ADP_PIB_ATTRIBUTE
attributeIndexThe index within the table of the specified IB attribute to read
pGetConfirmPointer to Get Confirm parameters containinf result and value. See ADP_GET_CFM_PARAMS

Returns

None.

Example

ADP_GET_CFM_PARAMS getConfirm;

ADP_GetRequestSync(ADP_IB_SOFT_VERSION, 0, &getConfirm);

// Check the result
if (getConfirm->status == G3_SUCCESS)
{
    // Value is stored in getConfirm->attributeValue
}

Remarks

None.