<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>BrlAPI: brlapi_writeArguments_t Struct Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.6 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="dirs.html"><span>Directories</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="functions.html"><span>Data Fields</span></a></li> </ul> </div> </div> <div class="contents"> <h1>brlapi_writeArguments_t Struct Reference<br> <small> [<a class="el" href="group__brlapi__write.html">Writing on the braille display</a>]</small> </h1><!-- doxytag: class="brlapi_writeArguments_t" --><code>#include <<a class="el" href="brlapi_8h-source.html">brlapi.h</a>></code> <p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Data Fields</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__writeArguments__t.html#e222cad591b4ae63aeb08e8f28b6e474">displayNumber</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__writeArguments__t.html#eb1b9ca2ff376769a8ae964f58e0f980">regionBegin</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__writeArguments__t.html#4b6ff5aa782053a662d0f6cd2e7102ef">regionSize</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__writeArguments__t.html#0c937c76e3012d14f36f60dceebd0e77">text</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__writeArguments__t.html#7eba82fd6e47f434c2c1278b41f229bd">textSize</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__writeArguments__t.html#317cb49eeb843c1fb1623beeec841238">andMask</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__writeArguments__t.html#0947ad21ed08a8bd5df93b0dae24e8e0">orMask</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__writeArguments__t.html#851dce39d2fe3b7125f319090285393f">cursor</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__writeArguments__t.html#accd788710ee4485ab40990d0ce1dd77">charset</a></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Structure containing arguments to be given to <a class="el" href="group__brlapi__write.html#g287f9a11719e1c350fb0280a38e0e069">brlapi_write()</a> <hr><h2>Field Documentation</h2> <a class="anchor" name="e222cad591b4ae63aeb08e8f28b6e474"></a><!-- doxytag: member="brlapi_writeArguments_t::displayNumber" ref="e222cad591b4ae63aeb08e8f28b6e474" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="structbrlapi__writeArguments__t.html#e222cad591b4ae63aeb08e8f28b6e474">brlapi_writeArguments_t::displayNumber</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Display number <a class="el" href="group__brlapi__write.html#gb1a71f82cac5d0b7ea1170697fe0dfc2">BRLAPI_DISPLAY_DEFAULT</a> == unspecified </div> </div><p> <a class="anchor" name="eb1b9ca2ff376769a8ae964f58e0f980"></a><!-- doxytag: member="brlapi_writeArguments_t::regionBegin" ref="eb1b9ca2ff376769a8ae964f58e0f980" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned int <a class="el" href="structbrlapi__writeArguments__t.html#eb1b9ca2ff376769a8ae964f58e0f980">brlapi_writeArguments_t::regionBegin</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Region of display to update, 1st character of display is 1 </div> </div><p> <a class="anchor" name="4b6ff5aa782053a662d0f6cd2e7102ef"></a><!-- doxytag: member="brlapi_writeArguments_t::regionSize" ref="4b6ff5aa782053a662d0f6cd2e7102ef" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned int <a class="el" href="structbrlapi__writeArguments__t.html#4b6ff5aa782053a662d0f6cd2e7102ef">brlapi_writeArguments_t::regionSize</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Number of characters held in text, andMask and orMask. </div> </div><p> <a class="anchor" name="0c937c76e3012d14f36f60dceebd0e77"></a><!-- doxytag: member="brlapi_writeArguments_t::text" ref="0c937c76e3012d14f36f60dceebd0e77" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">char* <a class="el" href="structbrlapi__writeArguments__t.html#0c937c76e3012d14f36f60dceebd0e77">brlapi_writeArguments_t::text</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Text to display, must hold as many characters as the region fields expresses. </div> </div><p> <a class="anchor" name="7eba82fd6e47f434c2c1278b41f229bd"></a><!-- doxytag: member="brlapi_writeArguments_t::textSize" ref="7eba82fd6e47f434c2c1278b41f229bd" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="structbrlapi__writeArguments__t.html#7eba82fd6e47f434c2c1278b41f229bd">brlapi_writeArguments_t::textSize</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Size of text in bytes. If -1, strlen() is used for computing it. </div> </div><p> <a class="anchor" name="317cb49eeb843c1fb1623beeec841238"></a><!-- doxytag: member="brlapi_writeArguments_t::andMask" ref="317cb49eeb843c1fb1623beeec841238" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned char* <a class="el" href="structbrlapi__writeArguments__t.html#317cb49eeb843c1fb1623beeec841238">brlapi_writeArguments_t::andMask</a> </td> </tr> </table> </div> <div class="memdoc"> <p> And attributes; applied first </div> </div><p> <a class="anchor" name="0947ad21ed08a8bd5df93b0dae24e8e0"></a><!-- doxytag: member="brlapi_writeArguments_t::orMask" ref="0947ad21ed08a8bd5df93b0dae24e8e0" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned char* <a class="el" href="structbrlapi__writeArguments__t.html#0947ad21ed08a8bd5df93b0dae24e8e0">brlapi_writeArguments_t::orMask</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Or attributes; applied <em>after</em> ANDing </div> </div><p> <a class="anchor" name="851dce39d2fe3b7125f319090285393f"></a><!-- doxytag: member="brlapi_writeArguments_t::cursor" ref="851dce39d2fe3b7125f319090285393f" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="structbrlapi__writeArguments__t.html#851dce39d2fe3b7125f319090285393f">brlapi_writeArguments_t::cursor</a> </td> </tr> </table> </div> <div class="memdoc"> <p> <a class="el" href="group__brlapi__write.html#gb0f523a333efcd272ac591785747f8ce">BRLAPI_CURSOR_LEAVE</a> == don't touch, <a class="el" href="group__brlapi__write.html#gdf7ed09ca3d6694bcd993fa3c351cebf">BRLAPI_CURSOR_OFF</a> == turn off, 1 = 1st char of display, ... </div> </div><p> <a class="anchor" name="accd788710ee4485ab40990d0ce1dd77"></a><!-- doxytag: member="brlapi_writeArguments_t::charset" ref="accd788710ee4485ab40990d0ce1dd77" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">char* <a class="el" href="structbrlapi__writeArguments__t.html#accd788710ee4485ab40990d0ce1dd77">brlapi_writeArguments_t::charset</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Text charset. NULL means it is assumed to be 8bits, and the same as the server's. "" means current locale's charset. If no locale was selected, defaults to NULL's meaning. </div> </div><p> <hr>The documentation for this struct was generated from the following file:<ul> <li><a class="el" href="brlapi_8h-source.html">brlapi.h</a></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 7 22:37:56 2009 for BrlAPI by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> </body> </html>