1<!DOCTYPE HTML PUBLIC "-//W3C//Dtd HTML 4.01 Transitional//EN">
2<html>
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=windows-1252" />
5<meta http-equiv="Content-Style-Type" content="text/css" />
6<link rel="stylesheet" type="text/css" href="../../CSS/revolution.css" />
7<title>ENCSetExternalEncoding</title>
8</head>
9
10<body>
11
12<h1>ENCSetExternalEncoding</h1>
13
14
15<h2>Syntax</h2>
16<dl><dd><pre class="construction">
17#include &lt;revolution/enc.h&gt;
18
19ENCResult ENCSetExternalEncoding(ENCContext* context, const u8* encoding);
20</pre></dd></dl>
21
22<h2>Arguments</h2>
23<TABLE class="arguments" border="1" >
24    <tr>
25<th>context</th>
26<td>Character code conversion context.</td>
27    </tr>
28    <tr>
29<th>encoding</th>
30<td>The character-string representation of the external character encoding name.<br>A termination character must be attached.</td>
31    </tr>
32</table>
33
34<h2>Return Values</h2>
35<p>
36<code>ENC_OK</code>: Normal exit.<br><code>ENC_ERR_INVALID_PARAM</code>: Invalid argument.<br><code>ENC_ERR_UNKNOWN_ENCODING</code>: Unidentifiable character encoding.<br><code>ENC_ERR_UNSUPPORTED</code>: Unsupported character code conversion.<br>
37</p>
38
39<h2>Description</h2>
40<p>
41This function specifies a character-string representation of the external character encoding name for the character code conversion context.<br>A termination character must be attached to the name of the external character encoding.<br>Refer to the <a href="../intro.html">ENC API Introduction</a> for details on supported character encodings.
42</p>
43<p><b><code>ENC_ERR_NOT_LOADED</code> was eliminated in RevolutionSDK 3.2.</b><br>If you specify a character encoding whose conversion table has been stripped, this function will return <code>ENC_ERR_UNSUPPORTED</code>.</p>
44
45<h2>See Also</h2>
46<P class="reference">
47<a href="../intro.html">ENC API Introduction</a><BR><a href="../Conversion/ENCGetExternalEncoding.html">ENCGetExternalEncoding</a>
48</p>
49
50<h2>Revision History</h2>
51<p>
522008/07/08 Added an explanation and link related to supported character encodings.<br>2008/03/31 Eliminated <code>ENC_ERR_NOT_LOADED</code>.<br>2007/02/05 Added <CODE>ENC_ERR_NOT_LOADED</CODE>.<br>2006/10/19 Initial version.<br>
53</p>
54
55<hr><p>CONFIDENTIAL</p></body>
56</html>