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<LINK rel="stylesheet" type="text/css" href="../../../CSS/revolution.css">
7<title>THPUtyReadTHPFrameHeader</title>
8</head>
9
10<body>
11
12<h1>THPUtyReadTHPFrameHeader</h1>
13
14<h2>Syntax</h2>
15<dl><dd><pre class="construction">
16#include &lt;win32/thputilities.h&gt;
17
18s32 THPUtyReadTHPFrameHeader(FILE* ip, THPFrameHeader* frameHeader, s32 componentNum);
19</pre></dd></dl>
20
21<h2>Arguments</h2>
22<TABLE class="arguments" border="1" >
23  <tr>
24<th>ip</th>
25<td>File pointer to THP movie data.</td>
26  </tr>
27  <tr>
28<th>frameHeader</th>
29<td>Pointer to the <code>THPFrameHeader</code> structure.</td>
30  </tr>
31  <tr>
32<th>componentNum</th>
33<td>Number of components contained in the THP movie data.</td>
34  </tr>
35</table>
36
37<h2>Return Values</h2>
38<p>
39Returns one of the following codes.
40</p>
41
42<TABLE class="arguments" border="1" >
43  <tbody>
44    <tr align="center">
45<td bgcolor="#CCCCCC">Code</td>
46<td bgcolor="#CCCCCC" width=50>Value</td>
47<td bgcolor="#CCCCCC">Description</td>
48    </tr>
49    <tr>
50<th>THP_ERROR_NOERROR</th>
51      <td align="center">0</td>
52<td>The function ended normally.</td>
53    </tr>
54    <tr>
55<th>THP_ERROR_FILEIO</th>
56      <td align="center">1</td>
57<td>Failed to read to or write from file.</td>
58    </tr>
59  </tbody>
60</table>
61
62<h2>Description</h2>
63<p>
64Reads a <code>THPFrameHeader</code> structure from the THP movie data specified by <SPAN class="argument">ip</SPAN>. The read position must already be set to the position of <code>THPFrameHeader</code>.
65</p>
66
67<h2>See Also</h2>
68<p>
69None.
70</p>
71
72<h2>Revision History</h2>
73<P>
742006/03/01 Initial version.<br>
75</P>
76
77<hr><p>CONFIDENTIAL</p></body>
78</html>