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_ConvertPathToFileID</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">FS_ConvertPathToFileID <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> <BR> <CODE>BOOL FS_ConvertPathToFileID( <A href="../fs_file_id_type.html">FSFileID</a> *p_file_id, const char *path );</CODE><br> <br>
20  </dd>
21</dl>
22<h2>Arguments</h2>
23<TABLE border="1" width="100%">
24  <TBODY>
25    <TR>
26<TD width="13%"><code>p_file_id</code></TD>
27<TD width="87%">Address of the <CODE>FSFileID</CODE> structure that holds results.</TD>
28    </TR>
29    <TR>
30<TD width="13%"><CODE>path</CODE></TD>
31<TD width="87%">File's path name</TD>
32    </TR>
33  </TBODY>
34</TABLE>
35
36<h2>Return Values</h2>
37<p>If the file ID is correctly acquired, it returns a value of TRUE. Otherwise it returns a value of FALSE.</p>
38
39<H2>Description</H2>
40<P>This function acquires the file ID from the specified path name. You can open a file by specifying its file ID when you call the <A href="FS_OpenFileFast.html"><code>FS_OpenFileFast</code></A> function. For more information on path name formatting, see the description of the <code><A href="FS_OpenFileEx.html">FS_OpenFileEx</A></code> function. <BR>
41</P>
42<H2>Note</H2>
43<p>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></p>
44<BR>
45<h2>See Also</h2>
46<p><CODE><A href="../fs_file_type.html">FSFile</A><BR> <A href="../fs_file_id_type.html">FSFileID</A><BR> <A href="FS_OpenFileFast.html">FS_OpenFileFast</A><BR> <A href="FS_OpenFileEx.html">FS_OpenFileEx</A></CODE></p>
47
48<H2>Revision History</H2>
49<P>
502008/10/02 Updated the See Also list.<br>2004/11/02 Corrected links.<br /> 2004/09/24 Added text under Note regarding the conditions for calling this function.<br /> 2004/05/20 Initial version.
51</P>
52<hr><p>CONFIDENTIAL</p></body>
53</html>
54