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>GetEnvironmentVariable</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/hio/Overview.html">hio</a>::<a href="../../../nn/hio/CTR/Overview.html">CTR</a>::GetEnvironmentVariable</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../nn/Result/Overview.html">Result</a> GetEnvironmentVariable(
15     <a href="../../../nn_types/s32.html">s32</a> * pLength,
16     char * buf,
17     <a href="../../../nn_types/s32.html">s32</a> length,
18     const char * name
19);
20</pre>
21    </div>
22<h2>Arguments</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>pLength</th>
35<td>Location in which to store the actual number of bytes that were copied.</td>
36        </tr>
37        <tr>
38<td>out</td>
39<th>buf</th>
40<td>Pointer to the buffer that will store the environment variable.</td>
41        </tr>
42        <tr>
43<td>in</td>
44<th>length</th>
45<td>Buffer size.</td>
46        </tr>
47        <tr>
48<td>in</td>
49<th>name</th>
50<td>Name of the environment variable.</td>
51        </tr> </table>
52    </div>
53<h2>Return Values</h2>
54<div class="section">Returns the result of the operation. Even if there is no environmental value, the function will return the value of the <CODE><a href="../../../nn/Result/IsSuccess.html">nn::Result::IsSuccess</a></CODE> function. </div>
55<h2>Description</h2>
56    <div class="section">
57<p>Gets the environment variable and returns the result of the process.</p><p>The value of the environment variable specified by <B>name</B> is stored in <B>buf</B>.<br />If the environment variable does not exist, &quot; <CODE>\0</CODE> &quot; is stored at the start of the buffer.</p><!-- write here --></div>
58<h2>Revision History</h2>
59    <div class="section">
60      <dl class="history">
61        <dt>2010/06/14</dt>
62<dd>Added description of arguments and behavior.<br />
63        </dd>
64        <dt>2010/03/31</dt>
65<dd>Initial version.<br />
66        </dd>
67      </dl>
68    </div>
69  <hr><p>CONFIDENTIAL</p></body>
70</html>
71