1<html>
2
3<head>
4<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
5<LINK rel="stylesheet" type="text/css" href="../../../CSS/revolution.css">
6<title>THPUtyReadTHPFrameHeader</title>
7</head>
8
9<body>
10
11<h1>THPUtyReadTHPFrameHeader</h1>
12
13<h2>C Specification</h2>
14
15<dl>
16<dd><pre><code>#include &lt;win32/thputilities.h&gt;</code></pre></dd>
17<dd><pre><code>s32 THPUtyReadTHPFrameHeader(FILE* ip, THPFrameHeader* frameHeader, s32 componentNum);</code></pre></dd>
18</dl>
19
20<h2>Arguments</h2>
21<table border="1" cellpadding="3" cellspacing="0.1">
22  <tr>
23<td width="120" bgcolor="#ffffe8"><strong><em><CODE>ip</CODE></em></strong></td>
24<td width="520">File pointer to the THP movie data.</td>
25  </tr>
26  <tr>
27<td width="120" bgcolor="#ffffe8"><strong><em><CODE>frameHeader</CODE></em></strong></td>
28<td width="520">Pointer to the <code>THPFrameHeader</code> structure.</td>
29  </tr>
30  <tr>
31<td width="120" bgcolor="#ffffe8"><strong><em><CODE>componentNum</CODE></em></strong></td>
32<td width="520">Number of components contained in the THP movie data.</td>
33  </tr>
34</table>
35
36<h2>Return Values</h2>
37<p>
38Returns one of the following codes:
39</p>
40
41<table border="1">
42  <tbody>
43    <tr align="center">
44<td>Code</td>
45<td width=50>Value</td>
46<td>Description</td>
47    </tr>
48    <tr>
49<td><CODE>THP_ERROR_NOERROR</CODE></td>
50      <td align="center">0</td>
51<td>The function ended normally.</td>
52    </tr>
53    <tr>
54<td><CODE>THP_ERROR_FILEIO</CODE></td>
55      <td align="center">1</td>
56<td>Failed to read or write from file. </td>
57    </tr>
58  </tbody>
59</table>
60
61<h2>Description</h2>
62<p>
63This function reads a <code>THPFrameHeader</code> structure from the THP movie data specified by <code>ip</code>. The read position must be set in advance to <code>THPFrameHeader</code>'s position.
64</p>
65
66<h2>See Also</h2>
67<p>
68None.
69</p>
70
71<h2>Revision History</h2>
72<P>03/01/2006 Initial version.</P>
73</body>
74</html>