NCDGetLinkStatus

C Specification

#include <revolution/ncd.h>
s32     NCDGetLinkStatus( void );

Description

Gets the current state for the NCD's automatic state transitioning.

Arguments

None.

Return Values

Returns one of the following state IDs when the state is obtained successfully.

#define     NCD_LINKSTATUS_WORKING          1       /* automatic state transition underway */
#define     NCD_LINKSTATUS_NONE             2       /* the link target device is not configured */
#define     NCD_LINKSTATUS_WIRED            3       /* link with the targetted wired device */
#define     NCD_LINKSTATUS_WIRELESS_DOWN    4       /* link not active for the targetted wireless device */
#define     NCD_LINKSTATUS_WIRELESS_UP      5       /* link established for the targetted wireless device */

Negative values indicate a failure. See the NCD API Error Values for the meanings of negative values.

If this function returns a value that does not indicate that the network hardware is enabled, that does not necessarily mean that communications are impossible or that network features such as Nintendo Wi-Fi are unavailable, or that they should be made unavailable. Instead, use an SO function to attempt to connect to the network device to determine if communications are possible. If communications are down, then by attempting to connect to the network device with an SO function, you can use the resulting error to display an error code and message that will help the user understand why network functionality is not currently available.

See Also

NCDSetIfConfig

Revision History

2007/11/21 Added a note.
2006/08/09 Initial version.


CONFIDENTIAL