ZPS_eAplZdpMgmtCacheRequest

ZPS_teStatus ZPS_eAplZdpMgmtCacheRequest(
    PDUM_thAPduInstance hAPduInst,
    ZPS_tuAddress uDstAddr,
    bool bExtAddr,
    uint8 *pu8SeqNumber,
    ZPS_tsAplZdpMgmtCacheReq *psZdpMgmtCacheReq);

Description

This function requests a remote node to provide a list of the End Devices registered in its primary discovery cache. Therefore, the destination node must contain a primary discovery cache.

Note: This function is provided in the ZDP API for the reason of interoperability with nodes running non-NXP ZigBee PRO stacks that support the generated request. On receiving a request from this function, the NXP ZigBee PRO stack will return the status ZPS_ZDP_NOT_SUPPORTED.

The request is represented by the structure below (further detailed in Section9.2.2.40).

typedef struct {

uint8 u8StartIndex;

} ZPS_tsAplZdpMgmtCacheReq;

The remote node replies with a Mgmt_Cache_rsp response, which should be collected using the function ZQ_bZQueueReceive() and stored in a structure of type ZPS_tsAplZdpMgmtCacheRsp(detailed in Section 9.2.3.40).

Parent topic:ZPS_eAplZdpMgmtCacheRequest

Parameters

• hAPduInst Handle of APDU in which request is sent.

• uDstAddr Address of destination node of request

• (can be 16- or 64-bit, as specified by bExtAddr)

• bExtAddr Type of destination address:

  • TRUE: 64-bit IEEE (MAC) address

  • FALSE: 16-bit network address

• * pu8SeqNumber Pointer to sequence number of request

• * psZdpMgmtCacheReq Pointer to request (see above)

Parent topic:ZPS_eAplZdpMgmtCacheRequest

Returns

• ZPS_E_SUCCESS (request successfully sent)

• 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_eAplZdpMgmtLeaveRequest

Parent topic:ZPS_eAplZdpMgmtDirectJoinRequest

Parent topic:ZPS_eAplZdpMgmtPermitJoiningRequest

Parent topic:ZPS_eAplZdpMgmtCacheRequest

Parent topic:Network Management Services functions