1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<HTML>
3<HEAD>
4<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
5<META http-equiv="Content-Style-Type" content="text/css">
6<TITLE>NCDGetLinkStatus</TITLE>
7<LINK rel="stylesheet" type="text/css" href="../CSS/revolution.css">
8</HEAD>
9<BODY>
10<H1>NCDGetLinkStatus</H1>
11
12<H2>C Specification</H2>
13<DL>
14  <DD><PRE><CODE>#include &lt;revolution/ncd.h&gt;</CODE></PRE>
15  <DD><PRE><CODE>s32     NCDGetLinkStatus( void );</CODE></PRE>
16</DL>
17
18<H2>Description</H2>
19<P>
20Gets the current state for the NCD's automatic state transitioning.
21</P>
22
23<H2>Arguments</H2>
24<P>None.</P>
25
26<h2>Return Values</h2>
27<P>
28Returns one of the following state IDs when the state is obtained successfully.
29</P>
30<PRE><CODE>#define     NCD_LINKSTATUS_WORKING          1       /* automatic state transition underway */
31#define     NCD_LINKSTATUS_NONE             2       /* the link target device is not configured */
32#define     NCD_LINKSTATUS_WIRED            3       /* link with the targetted wired device */
33#define     NCD_LINKSTATUS_WIRELESS_DOWN    4       /* link not active for the targetted wireless device */
34#define     NCD_LINKSTATUS_WIRELESS_UP      5       /* link established for the targetted wireless device */
35</CODE></PRE>
36<P>
37Negative values indicate a failure. See the <A href="NCDResult.html">NCD API Error Values</A> for the meanings of negative values.
38</P>
39<P>
40If 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.
41</P>
42
43
44<H2>See Also</H2>
45<P>
46<A href="NCDSetIfConfig.html"><CODE>NCDSetIfConfig</CODE></A>
47</P>
48
49<H2>Revision History</H2>
50<P>2007/11/21 Added a note. <BR> 2006/08/09 Initial version.</P>
51
52<hr><p>CONFIDENTIAL</p></body>
53</HTML>