1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META http-equiv="Content-Style-Type" content="text/css">
7<LINK rel="stylesheet" type="text/css" href="../CSS/revolution.css">
8<title>NANDGetHomeDir</title>
9</head>
10
11<body>
12
13<h1>NANDGetHomeDir</h1>
14
15<h2>C Specification</h2>
16<dl><dd><pre><code>
17#include &lt;revolution/nand.h&gt;
18
19s32 NANDGetHomeDir( char path[NAND_MAX_PATH] );
20</code></pre></dd></dl>
21
22<h2>Arguments</h2>
23<p>
24<TABLE border="1" >
25  <tr>
26<TD valign="top" width="120" bgcolor="#ffffe8"><CODE><STRONG><EM>path</EM></STRONG></CODE></TD>
27<TD width="520">A buffer that stores the character string of the home directory.</TD>
28  </tr>
29</TABLE>
30</p>
31
32<h2>Return Values</h2>
33<p>
34Returns one of the following codes:
35<p>
36<code>NAND_RESULT_OK<br> NAND_RESULT_UNKNOWN<br> NAND_RESULT_FATAL_ERROR<br></code>
37</p>
38</p>
39
40<H2>Description</H2>
41<p>
42Gets the home directory. The maximum path length in the file system is <code>NAND_MAX_PATH</code>. Therefore, creating a buffer large enough to store a path of this length is recommended.
43</p>
44
45<h2>See Also</h2>
46<p>
47<code><a href="./NANDGetCurrentDir.html">NANDGetCurrentDir</a></code>, <code><a href="./NANDChangeDir.html">NANDChangeDir</a></code>, <code><a href="./NANDChangeDirAsync.html">NANDChangeDirAsync</a></code>
48</p>
49
50<H2>Revision History</H2>
51<p>08/15/2006 Initial version.</p>
52
53<hr>
54<P>CONFIDENTIAL</p>
55</BODY>
56</HTML>
57