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_GetPathLength</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">FS_GetPathLength <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>s32 FS_GetPathLength( <A href="../fs_file_type.html">FSFile</a> *p_file );</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  </TBODY>
33</TABLE>
34<BR>
35
36<h2>Return Values</h2>
37<p>If it succeeds, it returns the length of the path name, including the terminating character &quot;\0&quot;. If it fails, it returns a value of -1.</p>
38
39<H2>Description</H2>
40<P>Gets the length of the path name (including the terminating character &quot;\0&quot;) of the specified file or directory. If you prepare at least as much memory as the return value before calling the <code><A href="FS_GetPathName.html">FS_GetPathName</A></code> function, it is guaranteed that the function will always succeed. <BR>
41</P>
42<H2>Note</H2>
43<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>
44<BR>
45<h2>See Also</h2>
46<p><CODE><A href="FS_GetPathName.html">FS_GetPathName</A></CODE></p>
47
48<H2>Revision History</H2>
49<P>
502004/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
51</P>
52<hr><p>CONFIDENTIAL</p></body>
53</html>
54