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">
14static <a href="../../../../nn/Result/Overview.html">nn::Result</a> GetClientState(
15     <a href="../../../../nn/dlp/CTR/ClientState.html">ClientState</a> * pClientState,
16     size_t * pTotalNum,
17     size_t * pDownloadedNum,
18     <a href="../../../../nn_types/u16.html">u16</a> nodeId
19);
20</pre>
21    </div>
22<h2>Parameters</h2>
23    <div class="section">
24      <table class="arguments">
25        <thead>
26          <tr>
27            <td width="15" />
28<th>Name</th>
29<td>Description</td>
30          </tr>
31        </thead>
32        <tr>
33<td>out</td>
34<th><CODE>pClientState</CODE></th>
35<td>Returns the client's state.</td>
36        </tr>
37        <tr>
38<td>out</td>
39<th>pTotalNum</th>
40<td>Returns the size (the number of packets) of the child to be downloaded. Note that zero can be returned. Keep this in mind if you plan to use this number as a divisor.</td>
41        </tr>
42        <tr>
43<td>out</td>
44<th>pDownloadedNum</th>
45<td>Returns the progress (the number of packets) of the child download.</td>
46        </tr>
47        <tr>
48<td>in</td>
49<th>nodeId</th>
50<td>Specifies the client's node ID.</td>
51        </tr> </table>
52    </div>
53<h2>Return Values</h2>
54<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 />
55      <table class="arguments">
56        <thead>
57          <tr>
58<th>Value</th>
59<td>Description</td>
60          </tr>
61        </thead>
62        <tr>
63<th><CODE>Result::IsSuccess</CODE></th>
64<td>Getting the client status succeeded.</td>
65        </tr>
66        <tr>
67<th><CODE>ResultInvalidState</CODE></th>
68<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>
69        </tr>
70        <tr>
71<th><CODE>ResultNoData</CODE></th>
72<td>No client with the specified node ID is connected.</td>
73        </tr>
74      </table> </div>
75<h2>Description</h2>
76    <div class="section">
77<p>Gets the client's state.</p>
78    </div>
79  <hr><p>CONFIDENTIAL</p></body>
80</html>
81