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">
14s32 GetEnvironmentVariable(
15     wchar_t * buf,
16     s32 length,
17     const wchar_t * name
18);
19</pre>
20    </div>
21<h2>Arguments</h2>
22    <div class="section">
23      <table class="arguments">
24        <thead>
25          <tr>
26            <td width="15" />
27<th>Name</th>
28<td>Description</td>
29          </tr>
30        </thead>
31        <tr>
32<td>out</td>
33<th>buf</th>
34<td>Pointer to the buffer that will store the environment variable.</td>
35        </tr>
36        <tr>
37<td>in</td>
38<th>length</th>
39<td>Buffer size.</td>
40        </tr>
41        <tr>
42<td>in</td>
43<th>name</th>
44<td>Name of the environment variable.</td>
45        </tr> </table>
46    </div>
47<h2>Return Values</h2>
48<div class="section">Returns the actual number of bytes that were copied. If an error occurred, returns <CODE>-1</CODE>. </div>
49<h2>Description</h2>
50    <div class="section">
51<p>Gets the environment variable and returns the number of bytes copied to the buffer. This is the overloaded member function when the variable name is specified in Unicode.</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. This is the overloaded member function when the variable name is specified in Unicode.</p><!-- write here --></div>
52<h2>Revision History</h2>
53    <div class="section">
54      <dl class="history">
55        <dt>2010/06/14</dt>
56<dd>Added description of arguments and behavior.<br />
57        </dd>
58        <dt>2010/03/31</dt>
59<dd>Initial version.<br />
60        </dd>
61      </dl>
62    </div>
63  <hr><p>CONFIDENTIAL</p></body>
64</html>
65