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 http-equiv="Content-Style-Type" content="text/css" />
7<link rel="stylesheet" type="text/css" href="../../CSS/revolution.css" />
8<title>ENCSetUnicodeBOM</title>
9</head>
10
11<body>
12
13<h1>ENCSetUnicodeBOM</h1>
14
15<h2>Syntax</h2>
16<dl><dd><pre class="construction">
17#include &lt;revolution/enc.h&gt;
18
19ENCResult ENCSetUnicodeBOM(u16* dst, s32 dstlen);
20
21ENCResult ENCSetUnicodeBOM8(u8 *dst, s32 dstlen);
22
23ENCResult ENCSetUnicodeBOM16(u16 *dst, s32 dstlen);
24
25ENCResult ENCSetUnicodeBOM32(u32 *dst, s32 dstlen);
26</pre></dd></dl>
27
28<h2>Arguments</h2>
29<TABLE class="arguments" border="1" >
30    <tr>
31<th>dst</th>
32<td>Write destination buffer for BOM.</td>
33    </tr>
34    <tr>
35<th>dstlen</th>
36<td>Size of the buffer to which data will be written. This is the size (buffer size/type size) of the type-conversion string in <SPAN class="argument">*dst</SPAN>.</td>
37    </tr>
38</table>
39
40<h2>Return Values</h2>
41<p>
42<code>ENC_OK</code>: Normal exit. <br><code>ENC_ERR_NO_BUF_LEFT</code>: Write destination buffer size insufficient.<br>
43</p>
44
45<h2>Description</h2>
46<p>This function writes the Unicode BOM to the buffer.</p>
47
48<h2>See Also</h2>
49<p>
50None.
51</p>
52
53<h2>Revision History</h2>
54<p>
552008/07/16 Added a description of the buffer size.<br>2006/08/08 Initial version.<br>
56</p>
57
58<hr><p>CONFIDENTIAL</p></body>
59</html>