<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html> <head profile="http://internetalchemy.org/2003/02/profile"> <link rel="foaf" type="application/rdf+xml" title="FOAF" href="http://www.openlinksw.com/dataspace/uda/about.rdf" /> <link rel="schema.dc" href="http://purl.org/dc/elements/1.1/" /> <meta name="dc.title" content="Function: charset_define - Virtuoso Functions Guide" /> <meta name="dc.subject" content="Function: charset_define - Virtuoso Functions Guide" /> <meta name="dc.creator" content="OpenLink Software Documentation Team ; " /> <meta name="dc.copyright" content="OpenLink Software, 1999 - 2009" /> <link rel="top" href="index.html" title="OpenLink Virtuoso Universal Server: Documentation" /> <link rel="search" href="/doc/adv_search.vspx" title="Search OpenLink Virtuoso Universal Server: Documentation" /> <link rel="parent" href="functions.html" title="Chapter Contents" /> <link rel="prev" href="appendixa.html" title="Appendix" /> <link rel="next" href="functions.html#.html" title="" /> <link rel="shortcut icon" href="../images/misc/favicon.ico" type="image/x-icon" /> <link rel="stylesheet" type="text/css" href="doc.css" /> <link rel="stylesheet" type="text/css" href="/doc/translation.css" /> <title>Function: charset_define - Virtuoso Functions Guide</title> <meta http-equiv="Content-Type" content="text/xhtml; charset=UTF-8" /> <meta name="author" content="OpenLink Software Documentation Team ; " /> <meta name="copyright" content="OpenLink Software, 1999 - 2009" /> <meta name="keywords" content="" /> <meta name="GENERATOR" content="OpenLink XSLT Team" /> </head> <body> <div id="header"> <a name="fn_charset_define" /> <img src="../images/misc/logo.jpg" alt="" /> <h1>22. Virtuoso Functions Guide - charset_define</h1> </div> <div id="navbartop"> <div> <a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="functions.html#ldap" title="LDAP">Prev</a> | <a class="link" href="fn_charset_recode.html" title="charset_recode">Next</a> </div> </div> <div id="currenttoc"> <form method="post" action="/doc/adv_search.vspx"> <div class="search">Keyword Search: <br /> <input type="text" name="q" /> <input type="submit" name="go" value="Go" /> </div> </form> <div> <a href="http://www.openlinksw.com/">www.openlinksw.com</a> </div> <div> <a href="http://docs.openlinksw.com/">docs.openlinksw.com</a> </div> <br /> <div> <a href="index.html">Book Home</a> </div> <br /> <div> <a href="contents.html">Contents</a> </div> <div> <a href="preface.html">Preface</a> </div> <br /> <div> <a class="selected" href="functions.html">Virtuoso Functions Guide</a> </div> <br /> <div> <a href="functions.html#admin">Administration</a> </div> <div> <a href="functions.html#aggr">Aggregate Functions</a> </div> <div> <a href="functions.html#array">Array Manipulation</a> </div> <div> <a href="functions.html#bpel">BPEL APIs</a> </div> <div> <a href="functions.html#backup">Backup</a> </div> <div> <a href="functions.html#compression">Compression</a> </div> <div> <a href="functions.html#cursors">Cursor</a> </div> <div> <a href="functions.html#time">Date & Time Manipulation</a> </div> <div> <a href="functions.html#debug">Debug</a> </div> <div> <a href="functions.html#dict">Dictionary Manipulation</a> </div> <div> <a href="functions.html#encoding">Encoding & Decoding</a> </div> <div> <a href="functions.html#file">File Manipulation</a> </div> <div> <a href="functions.html#ft">Free Text</a> </div> <div> <a href="functions.html#hash">Hashing / Cryptographic</a> </div> <div> <a href="functions.html#ldap">LDAP</a> </div> <div> <a class="selected" href="functions.html#localization">Locale</a> </div> <div class="selected"> <div> <a class="selected" href="fn_charset_define.html">charset_define</a> </div> <div> <a href="fn_charset_recode.html">charset_recode</a> </div> <div> <a href="fn_charsets_list.html">charsets_list</a> </div> <div> <a href="fn_current_charset.html">current_charset</a> </div> <div> <a href="fn_elh_get_handler.html">elh_get_handler</a> </div> <div> <a href="fn_elh_load_handler.html">elh_load_handler</a> </div> <div> <a href="fn_lh_get_handler.html">lh_get_handler</a> </div> <div> <a href="fn_lh_load_handler.html">lh_load_handler</a> </div> </div> <div> <a href="functions.html#mail">Mail</a> </div> <div> <a href="functions.html#misc">Miscellaneous</a> </div> <div> <a href="functions.html#number">Number</a> </div> <div> <a href="functions.html#phrz">Phrases</a> </div> <div> <a href="functions.html#rdf">RDF data</a> </div> <div> <a href="functions.html#rmt">Remote SQL Data Source</a> </div> <div> <a href="functions.html#repl">Replication</a> </div> <div> <a href="functions.html#soap">SOAP</a> </div> <div> <a href="functions.html#sql">SQL</a> </div> <div> <a href="functions.html#string">String</a> </div> <div> <a href="functions.html#txn">Transaction</a> </div> <div> <a href="functions.html#type">Type Mapping</a> </div> <div> <a href="functions.html#uddi">UDDI</a> </div> <div> <a href="functions.html#udt">User Defined Types & The CLR</a> </div> <div> <a href="functions.html#vad">VAD</a> </div> <div> <a href="functions.html#jvmpl">Virtuoso Java PL API</a> </div> <div> <a href="functions.html#bif">Virtuoso Server Extension Interface (VSEI)</a> </div> <div> <a href="functions.html#ws">Web & Internet</a> </div> <div> <a href="functions.html#xml">XML</a> </div> <div> <a href="functions.html#XPATH">XPATH & XQUERY</a> </div> <br /> <div> <a href="functionidx.html">Functions Index</a> </div> <br /> </div> <div id="text"> <h2>charset_define</h2> <div class="refpurpose">Define a character set.</div> <div class="funcsynopsis"> <span class="funcdef"> <span class="function">charset_define</span> </span> (<span class="paramdef">in <span class="parameter">name</span> varchar</span>, <span class="paramdef">in <span class="parameter">charset_string</span> any</span>, <span class="paramdef">in <span class="parameter">aliases</span> any</span>); </div> <div class="refsect1"> <div class="refsect1title">Description</div> <p>This function creates a new narrow language-specific character set, or redefines an existing one.</p> </div> <div class="refsect1"> <div class="refsect1title">Parameters</div> <div class="refsect2"> <span class="refsect2title">name – </span> The name of the character set to define. This becomes the "preferred" name of the character set. </div> <div class="refsect2"> <span class="refsect2title">charset_string – </span> Wide string with the character codes for each given character from 1 to 255. That is, a 255-byte long NCHAR defining the Unicode codes for narrow chars 1-255. </div> <div class="refsect2"> <span class="refsect2title">aliases – </span> Vector of character set names that are to be aliases of the character set being defined. Use NULL if there are to be no aliases. </div> </div> <div class="refsect1"> <div class="refsect1title">Return Types</div> <p>None</p> </div> <div class="refsect1title">Errors</div> <table class="data"> <tr> <th class="data">sqlstate</th> <th class="data">error code</th> <th class="data">error text</th> </tr> <tr> <td class="data"> <a name="err2C000" /> <span class="errorcode">2C000</span> </td> <td class="data"> <a name="errIN001" /> <span class="errorcode">IN001</span> </td> <td class="data"> <span class="errorname">The UTF-8 is not a redefinable charset</span> </td> </tr> <tr> <td class="data"> <a name="err2C000" /> <span class="errorcode">2C000</span> </td> <td class="data"> <a name="errIN002" /> <span class="errorcode">IN002</span> </td> <td class="data"> <span class="errorname">charset_define : Charset table not a wide string</span> </td> </tr> <tr> <td class="data"> <a name="err2C000" /> <span class="errorcode">2C000</span> </td> <td class="data"> <a name="errIN003" /> <span class="errorcode">IN003</span> </td> <td class="data"> <span class="errorname">charset_define : 0 not allowed as a charset definition</span> </td> </tr> <tr> <td class="data"> <a name="err2C000" /> <span class="errorcode">2C000</span> </td> <td class="data"> <a name="errIN004" /> <span class="errorcode">IN004</span> </td> <td class="data"> <span class="errorname">charset <name> already defined. Drop it first</span> </td> </tr> <tr> <td class="data"> <a name="err2C000" /> <span class="errorcode">2C000</span> </td> <td class="data"> <a name="errIN005" /> <span class="errorcode">IN005</span> </td> <td class="data"> <span class="errorname">Alias <position> is not of type STRING</span> </td> </tr> </table> <br /> <p /> <div class="refsect1"> <div class="refsect1title">Examples</div> <a name="ex_charset_define" /> <div class="example"> <div class="exampletitle">New 4th character, and aliases</div> <p>To setup the 4th character to be Unicode 0xffce, and give the character set 2 aliases, you would make a call like this:</p> <div> <pre class="programlisting">charset_define ('NEW-CHARSET', N'\x1\x2\x3\xffce\x5....' , vector ('SOME-CHARSET', 'ANOTHER-CHARSET'));</pre> </div> <p>The character string should contain 255 wide characters that are arbitrary unicode values.</p> </div> </div> <div class="refsect1"> <div class="refsect1title">See Also</div> <p> <a href="fn_charsets_list.html">charsets_list()</a> </p> </div> </div> <div id="footer"> <div>Copyright© 1999 - 2009 OpenLink Software All rights reserved.</div> <div id="validation"> <a href="http://validator.w3.org/check/referer"> <img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /> </a> <a href="http://jigsaw.w3.org/css-validator/"> <img src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!" height="31" width="88" /> </a> </div> </div> </body> </html>