Descriptor functions

The AF Descriptor functions allow ZigBee descriptors for the local node to be copied to and from the context area of the ZigBee PRO stack. The functions are listed below.

ZPS_eAplAfGetNodeDescriptor

ZPS\_teStatus ZPS\_eAplAfGetNodeDescriptor\(
            ZPS\_tsAplAfNodeDescriptor *psDesc);

Description

This function copies the Node descriptor (for the local node) from the context area of the stack to the specified structure (the descriptor is returned through the function’s parameter).

Parent topic:ZPS_eAplAfGetNodeDescriptor

Parameters

* psDesc: Pointer to structure (see Section 8.2.1.1) to receive Node descriptor.

Parent topic:ZPS_eAplAfGetNodeDescriptor

Returns

ZPS_E_SUCCESS
APS return codes, listed and described in Section 11.2.2
NWK return codes, listed and described in Section 11.2.3
MAC return codes, listed and described in Section 11.2.4

Parent topic:ZPS_eAplAfGetNodeDescriptor

Parent topic:Descriptor functions

ZPS_eAplAfGetNodePowerDescriptor

ZPS\_teStatus ZPS\_eAplAfGetNodePowerDescriptor\(
            ZPS\_tsAplAfNodePowerDescriptor *psDesc);

Description

This function copies the Node Power descriptor (for the local node) from the context area of the stack to the specified structure (the descriptor is returned through the function’s parameter).

Parent topic:ZPS_eAplAfGetNodePowerDescriptor

Parameters

* psDesc Pointer to structure (see Section 8.2.1.2) to receive Node Power descriptor

Parent topic:ZPS_eAplAfGetNodePowerDescriptor

Returns

ZPS_E_SUCCESS
APS return codes, listed and described in Section 11.2.2
NWK return codes, listed and described in Section 11.2.3
MAC return codes, listed and described in Section 11.2.4

Parent topic:ZPS_eAplAfGetNodePowerDescriptor

Parent topic:Descriptor functions

ZPS_eAplAfGetSimpleDescriptor

ZPS\_teStatus ZPS\_eAplAfGetSimpleDescriptor\(
        uint8 u8Endpoint,
        ZPS\_tsAplAfSimpleDescriptor *psDesc);

Description

This function copies the Simple descriptor for the specified endpoint (on the local node) from the context area of the stack to the specified structure (the descriptor is returned through the function’s parameter).

Parent topic:ZPS_eAplAfGetSimpleDescriptor

Parameters

* psDesc Pointer to structure (see Section 8.2.1.3) to receive Simple descriptor

Parent topic:ZPS_eAplAfGetSimpleDescriptor

Returns

ZPS_E_SUCCESS
APS return codes, listed and described in Section 11.2.2
NWK return codes, listed and described in Section 11.2.3
MAC return codes, listed and described in Section 11.2.4

Parent topic:ZPS_eAplAfGetSimpleDescriptor

Parent topic:Descriptor functions

Parent topic:AF API functions