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 name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.0.0 for Windows">
7<META http-equiv="Content-Style-Type" content="text/css">
8<title>FS_GetPathName</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">FS_GetPathName <img src="../../image/NTR.gif"align="middle"><img src="../../image/TWL.gif" align="middle"></h1>
15<h2>Syntax</h2>
16
17<dl>
18  <dd>
19<CODE>#include &lt;nitro/fs.h&gt;</CODE><BR>
20  <BR>
21  <CODE>BOOL FS_GetPathName( <A href="../fs_file_type.html">FSFile</a> *p_file, char *buf, u32 len );</CODE><br>
22  <br>
23  </dd>
24</dl>
25<h2>Arguments</h2>
26<TABLE border="1" width="100%">
27  <TBODY>
28    <TR>
29      <TD width="13%"><EM><STRONG>p_file</STRONG></EM></TD>
30      <TD width="87%">Address of the <A href="../fs_file_type.html"><CODE>FSFile</CODE></A> structure.</TD>
31    </TR>
32    <TR>
33      <TD width="13%"><EM><STRONG>buf</STRONG></EM></TD>
34      <TD width="87%">Address of the buffer that holds the path name</TD>
35    </TR>
36    <TR>
37      <TD width="13%"><EM><STRONG>len</STRONG></EM></TD>
38      <TD width="87%">Byte size of <code><EM><STRONG>buf</STRONG></EM></code>.</TD>
39    </TR>
40  </TBODY>
41</TABLE>
42<BR>
43
44<h2>Return Values</h2>
45<p>Returns a value of TRUE if it succeeds. Returns a value of <CODE>FALSE</CODE> if it fails.</p>
46
47<H2>Description</H2>
48<P>Gets the path name (including the terminating character &quot;\0&quot;) of the specified file or directory. If the file or directory is not valid, or if the buffer size is insufficient, it stores a value of FALSE without storing anything in the buffer. <BR>
49</P>
50<H2>Note</H2>
51<p><font color="#800000">This function cannot be called from the interrupt handler (IRQ mode).<br> Also note that in some cases processing may not end if interrupts are left prohibited.<br></font></p>
52<BR>
53<h2>See Also</h2>
54<p><CODE><A href="FS_GetPathLength.html">FS_GetPathLength</A></CODE></p>
55
56<H2>Revision History</H2>
57<P>
582004/11/02 Corrected the name of an argument.<br> 2004/09/24 Added the description in the Caution section regarding the conditions for calling this function.<br> 2004/06/15 Changed terminating NUL to terminating character &quot;\0.&quot;<br> 2004/05/19 Initial version.
59</P>
60<hr><p>CONFIDENTIAL</p></body>
61</html>
62