CHT_GetPictochatRoomNumber

C Specification

#include <nitro/cht.h>

int CHT_GetPictochatRoomNumber( const WMBssDesc* pWmBssDesc );

Arguments

pWmBssDesc Specifies the pointer to the beacon information being checked.

Return Values

Returns the room number (0 to 3) of the room opened by the PictoChat parent. If the beacon information specified by the argument is invalid, -1 is returned.

Description

Checks the PictoChat parent's beacon information to determine the room number of the room opened by the PictoChat parent. Rooms 0 to 3 correspond to Chat Rooms A to D. Before using this function to get the room number, be sure to use CHT_IsPictochatParent to make sure that the beacon information being checked is that of a PictoChat parent. If it is not the beacon information of a PictoChat parent, an undefined value will be returned to the argument.

See Also

CHT_IsPictochatParent, WMBssDesc

Revision History

03/02/2005 Added explanation of return value.
12/24/2004 Initial version