5.1.2.7 ZDO_GetNeibTable Function

Syntax

void ZDO_GetNeibTable(ZDO_Neib_t *table);

Description

This function retrieves the neighbor table.

The function writes the contents of the neighbor table to the buffer specified by a pointer to it.

Note: Not all entries of the neighbor table are included, namely only neighbors with RELATIONSHIP_PARENT, RELATIONSHIP_CHILD and RELATIONSHIP_NONE_OF_ABOVE relationships are included (in addition, this implies that information about unauthenticated children is not retrieved).

The space for the buffer must be allocated at compile time; that is, the variable for the buffer must be declared as static. The following code example demonstrates a typical way to call the function:

static ZDO_Neib_t neighborTable[CS_NEIB_TABLE_SIZE]; // Buffer for the neighbor table
...
ZDO_GetNeibTable(neighborTable);

Input Parameters


Parameter Name	Description
`table`	Pointer to store the address of the neighbor table

Return Type and Values

None