1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../../css/manpage.css" type="text/css" />
7    <title>GetClientState</title>
8  </head>
9  <body>
10    <h1><CODE><a href="../../../../nn/Overview.html">nn</a>::<a href="../../../../nn/dlp/Overview.html">dlp</a>::<a href="../../../../nn/dlp/CTR/Overview.html">CTR</a>::<a href="../../../../nn/dlp/CTR/Server/Overview.html">Server</a>::GetClientState</CODE> Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<CODE>static <a href="../../../../nn/Result/Overview.html">nn::Result</a> GetClientState(</CODE>
15     <CODE><a href="../../../../nn/dlp/CTR/ClientState.html">ClientState</a> * pClientState,</CODE>
16     u16 nodeId
17);
18</pre>
19    </div>
20    <h2>Arguments</h2>
21    <div class="section">
22      <table class="arguments">
23        <thead>
24          <tr>
25            <td width="15" />
26            <th>Name</th>
27            <td>Description</td>
28          </tr>
29        </thead>
30        <tr>
31          <td>out</td>
32          <th><CODE>pClientState</CODE></th>
33          <td>Returns the client's state.</td>
34        </tr>
35        <tr>
36          <td>in</td>
37          <th>nodeId</th>
38          <td>Specifies the client's node ID.</td>
39        </tr> </table>
40    </div>
41    <h2>Return Values</h2>
42    <div class="section">The following <a href="../../../../nn/Result/Overview.html"><CODE>Result</CODE></a> values are returned as the result of the operation.<br /> <br />
43      <table class="arguments">
44        <thead>
45          <tr>
46            <th>Value</th>
47            <td>Description</td>
48          </tr>
49        </thead>
50        <tr>
51          <th><CODE>Result::IsSuccess</CODE></th>
52          <td>Getting the client status succeeded.</td>
53        </tr>
54        <tr>
55          <th><CODE>ResultInvalidState</CODE></th>
56          <td>The state is invalid. This function can be used after the <CODE><a href="../../../../nn/dlp/CTR/Server/OpenSessions.html">OpenSessions</a></CODE> function has succeeded (<CODE>SERVER_STATE_OPENED_SESSIONS</CODE>) if the state is not <CODE>SERVER_STATE_ERROR</CODE>.</td>
57        </tr>
58        <tr>
59          <th><CODE>ResultNoData</CODE></th>
60          <td>No client with the specified node ID is connected.</td>
61        </tr>
62      </table> </div>
63    <h2>Description</h2>
64    <div class="section">
65      <p>Gets the client's state.</p>
66    </div>
67  <hr><p>CONFIDENTIAL</p></body>
68</html>
69