<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>open-vm-tools 9.4.0: Internationalization</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">open-vm-tools 9.4.0
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Internationalization</div> </div>
</div><!--header-->
<div class="contents">
<p>Functions and macros to help with internationalization of applications.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaa9ffa836affaa6041250981c2eb83907"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaa9ffa836affaa6041250981c2eb83907"></a>
#define </td><td class="memItemRight" valign="bottom"><b>MSG_MAGIC</b>   "@&!*@*@"</td></tr>
<tr class="separator:gaa9ffa836affaa6041250981c2eb83907"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga01ac41bbe080426e901d13e789b6f4c1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga01ac41bbe080426e901d13e789b6f4c1"></a>
#define </td><td class="memItemRight" valign="bottom"><b>MSG_MAGIC_LEN</b>   7</td></tr>
<tr class="separator:ga01ac41bbe080426e901d13e789b6f4c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga96815b8c1c485ef5b07fd755ab2d0a84"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga96815b8c1c485ef5b07fd755ab2d0a84"></a>
#define </td><td class="memItemRight" valign="bottom"><b>MSGID</b>(id)   MSG_MAGIC "(" #id ")"</td></tr>
<tr class="separator:ga96815b8c1c485ef5b07fd755ab2d0a84"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadf2f13adae64033a57a375c7b4f5663b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vmtools__i18n.html#gadf2f13adae64033a57a375c7b4f5663b">SU_</a>(msgid, en)   <a class="el" href="group__vmtools__i18n.html#ga6ea11fbd4a24f41c67c689bb3ac2dedf">VMTools_GetString</a>(VMW_TEXT_DOMAIN, MSGID(msgid) en)</td></tr>
<tr class="separator:gadf2f13adae64033a57a375c7b4f5663b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gade3c6a33fa398f89c0ba6dea4ef377f9"><td class="memItemLeft" align="right" valign="top">G_BEGIN_DECLS void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vmtools__i18n.html#gade3c6a33fa398f89c0ba6dea4ef377f9">VMTools_BindTextDomain</a> (const char *domain, const char *locale, const char *catdir)</td></tr>
<tr class="separator:gade3c6a33fa398f89c0ba6dea4ef377f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6ea11fbd4a24f41c67c689bb3ac2dedf"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vmtools__i18n.html#ga6ea11fbd4a24f41c67c689bb3ac2dedf">VMTools_GetString</a> (const char *domain, const char *msgid)</td></tr>
<tr class="separator:ga6ea11fbd4a24f41c67c689bb3ac2dedf"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Functions and macros to help with internationalization of applications. </p>
<p>To create a localizable string, use the MSGID macro in the following manner:</p>
<div class="fragment"><div class="line">* <a class="code" href="group__vmtools__i18n.html#ga6ea11fbd4a24f41c67c689bb3ac2dedf">VMTools_GetString</a>(<span class="stringliteral">"domain"</span>, MSGID(message.id) <span class="stringliteral">"Default English text."</span>)</div>
<div class="line">* </div>
</div><!-- fragment --><p>Or, in shorthand form:</p>
<div class="fragment"><div class="line">* <a class="code" href="group__vmtools__i18n.html#gadf2f13adae64033a57a375c7b4f5663b">SU_</a>(message.id, <span class="stringliteral">"Default English text."</span>)</div>
<div class="line">* </div>
</div><!-- fragment --><p>This will instruct the code to retrive the message under key "message.id" in the translation catalog for the configured locale.</p>
<p>The shorthand macros use the VMW_TEXT_DOMAIN macro to identify the domain from which translated messages will be loaded. Each domain should first be initialized by calling <a class="el" href="group__vmtools__i18n.html#gade3c6a33fa398f89c0ba6dea4ef377f9">VMTools_BindTextDomain()</a>. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gadf2f13adae64033a57a375c7b4f5663b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SU_</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">msgid, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">en </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   <a class="el" href="group__vmtools__i18n.html#ga6ea11fbd4a24f41c67c689bb3ac2dedf">VMTools_GetString</a>(VMW_TEXT_DOMAIN, MSGID(msgid) en)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Shorthand macro to retrieve a localized message in UTF-8.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">msgid</td><td>The message ID. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">en</td><td>English version of the message.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A localized message. </dd></dl>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gade3c6a33fa398f89c0ba6dea4ef377f9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">G_BEGIN_DECLS void VMTools_BindTextDomain </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>domain</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>lang</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>catdir</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Loads the message catalog for a text domain. Each text domain contains a different set of messages loaded from a different catalog.</p>
<p>If a catalog has already been bound to the given name, it is replaced with the newly loaded data.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">domain</td><td>Name of the text domain being loaded. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lang</td><td>Language code for the text domain. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">catdir</td><td>Root directory of catalog files (NULL = default). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga6ea11fbd4a24f41c67c689bb3ac2dedf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* VMTools_GetString </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>domain</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>msgid</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a localized version of the requested string in UTF-8.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">domain</td><td>Text domain. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">msgid</td><td>Message id (including English translation).</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The localized string. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Nov 13 2013 17:04:41 for open-vm-tools 9.4.0 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
