Sophie

Sophie

distrib > Mageia > 5 > i586 > media > core-updates > by-pkgid > 67d6f1fcdf59eeb6f1363fc33c40091c > files > 382

icu-doc-53.1-12.6.mga5.noarch.rpm

<!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.6"/>
<title>ICU 53.1: icu::CheckedArrayByteSink Class Reference</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</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">ICU 53.1
   &#160;<span id="projectnumber">53.1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceicu.html">icu</a></li><li class="navelem"><a class="el" href="classicu_1_1CheckedArrayByteSink.html">CheckedArrayByteSink</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">icu::CheckedArrayByteSink Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Implementation of <a class="el" href="classicu_1_1ByteSink.html" title="A ByteSink can be filled with bytes. ">ByteSink</a> that writes to a flat byte array, with bounds-checking: This sink will not write more than capacity bytes to outbuf.  
 <a href="classicu_1_1CheckedArrayByteSink.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="bytestream_8h_source.html">bytestream.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for icu::CheckedArrayByteSink:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classicu_1_1CheckedArrayByteSink.png" usemap="#icu::CheckedArrayByteSink_map" alt=""/>
  <map id="icu::CheckedArrayByteSink_map" name="icu::CheckedArrayByteSink_map">
<area href="classicu_1_1ByteSink.html" title="A ByteSink can be filled with bytes. " alt="icu::ByteSink" shape="rect" coords="0,56,167,80"/>
<area href="classicu_1_1UMemory.html" title="UMemory is the common ICU base class. " alt="icu::UMemory" shape="rect" coords="0,0,167,24"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2ad2fd80f945eb971384e704a24a4da4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CheckedArrayByteSink.html#a2ad2fd80f945eb971384e704a24a4da4">CheckedArrayByteSink</a> (char *outbuf, int32_t capacity)</td></tr>
<tr class="memdesc:a2ad2fd80f945eb971384e704a24a4da4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a <a class="el" href="classicu_1_1ByteSink.html" title="A ByteSink can be filled with bytes. ">ByteSink</a> that will write to outbuf[0..capacity-1].  <a href="#a2ad2fd80f945eb971384e704a24a4da4">More...</a><br/></td></tr>
<tr class="separator:a2ad2fd80f945eb971384e704a24a4da4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f00ab1d8ddcd922c65449ebb435bc04"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CheckedArrayByteSink.html#a2f00ab1d8ddcd922c65449ebb435bc04">~CheckedArrayByteSink</a> ()</td></tr>
<tr class="memdesc:a2f00ab1d8ddcd922c65449ebb435bc04"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a2f00ab1d8ddcd922c65449ebb435bc04">More...</a><br/></td></tr>
<tr class="separator:a2f00ab1d8ddcd922c65449ebb435bc04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abba65c7ce58ff4932a445660d6d6946e"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classicu_1_1CheckedArrayByteSink.html">CheckedArrayByteSink</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CheckedArrayByteSink.html#abba65c7ce58ff4932a445660d6d6946e">Reset</a> ()</td></tr>
<tr class="memdesc:abba65c7ce58ff4932a445660d6d6946e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the sink to its original state, without modifying the buffer.  <a href="#abba65c7ce58ff4932a445660d6d6946e">More...</a><br/></td></tr>
<tr class="separator:abba65c7ce58ff4932a445660d6d6946e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa927725da1eec2f646f7be734d4d4c06"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CheckedArrayByteSink.html#aa927725da1eec2f646f7be734d4d4c06">Append</a> (const char *bytes, int32_t n)</td></tr>
<tr class="memdesc:aa927725da1eec2f646f7be734d4d4c06"><td class="mdescLeft">&#160;</td><td class="mdescRight">Append "bytes[0,n-1]" to this.  <a href="#aa927725da1eec2f646f7be734d4d4c06">More...</a><br/></td></tr>
<tr class="separator:aa927725da1eec2f646f7be734d4d4c06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20f2bd9b3666a6fcb9782a0015bc6c42"><td class="memItemLeft" align="right" valign="top">virtual char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CheckedArrayByteSink.html#a20f2bd9b3666a6fcb9782a0015bc6c42">GetAppendBuffer</a> (int32_t min_capacity, int32_t desired_capacity_hint, char *scratch, int32_t scratch_capacity, int32_t *result_capacity)</td></tr>
<tr class="memdesc:a20f2bd9b3666a6fcb9782a0015bc6c42"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a writable buffer for appending and writes the buffer's capacity to *result_capacity.  <a href="#a20f2bd9b3666a6fcb9782a0015bc6c42">More...</a><br/></td></tr>
<tr class="separator:a20f2bd9b3666a6fcb9782a0015bc6c42"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a855275c60617b7c4732a12058e490331"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CheckedArrayByteSink.html#a855275c60617b7c4732a12058e490331">NumberOfBytesWritten</a> () const </td></tr>
<tr class="memdesc:a855275c60617b7c4732a12058e490331"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of bytes actually written to the sink.  <a href="#a855275c60617b7c4732a12058e490331">More...</a><br/></td></tr>
<tr class="separator:a855275c60617b7c4732a12058e490331"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad14f1783aa30e2cea50ce063d26f37af"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CheckedArrayByteSink.html#ad14f1783aa30e2cea50ce063d26f37af">Overflowed</a> () const </td></tr>
<tr class="memdesc:ad14f1783aa30e2cea50ce063d26f37af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if any bytes were discarded, i.e., if there was an attempt to write more than 'capacity' bytes.  <a href="#ad14f1783aa30e2cea50ce063d26f37af">More...</a><br/></td></tr>
<tr class="separator:ad14f1783aa30e2cea50ce063d26f37af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e70bb360869780ab3252b45ff1ea4d3"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1CheckedArrayByteSink.html#a3e70bb360869780ab3252b45ff1ea4d3">NumberOfBytesAppended</a> () const </td></tr>
<tr class="memdesc:a3e70bb360869780ab3252b45ff1ea4d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of bytes appended to the sink.  <a href="#a3e70bb360869780ab3252b45ff1ea4d3">More...</a><br/></td></tr>
<tr class="separator:a3e70bb360869780ab3252b45ff1ea4d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classicu_1_1ByteSink"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classicu_1_1ByteSink')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classicu_1_1ByteSink.html">icu::ByteSink</a></td></tr>
<tr class="memitem:ac3e9a257c1fd9e981bceb8f6981d9b6e inherit pub_methods_classicu_1_1ByteSink"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ByteSink.html#ac3e9a257c1fd9e981bceb8f6981d9b6e">ByteSink</a> ()</td></tr>
<tr class="memdesc:ac3e9a257c1fd9e981bceb8f6981d9b6e inherit pub_methods_classicu_1_1ByteSink"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#ac3e9a257c1fd9e981bceb8f6981d9b6e">More...</a><br/></td></tr>
<tr class="separator:ac3e9a257c1fd9e981bceb8f6981d9b6e inherit pub_methods_classicu_1_1ByteSink"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeea90b9a402f4446d493f7e6cc3361c0 inherit pub_methods_classicu_1_1ByteSink"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ByteSink.html#aeea90b9a402f4446d493f7e6cc3361c0">~ByteSink</a> ()</td></tr>
<tr class="memdesc:aeea90b9a402f4446d493f7e6cc3361c0 inherit pub_methods_classicu_1_1ByteSink"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor.  <a href="#aeea90b9a402f4446d493f7e6cc3361c0">More...</a><br/></td></tr>
<tr class="separator:aeea90b9a402f4446d493f7e6cc3361c0 inherit pub_methods_classicu_1_1ByteSink"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8b12cabefa31cfcdd1dc166a9f829f2 inherit pub_methods_classicu_1_1ByteSink"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ByteSink.html#ad8b12cabefa31cfcdd1dc166a9f829f2">Flush</a> ()</td></tr>
<tr class="memdesc:ad8b12cabefa31cfcdd1dc166a9f829f2 inherit pub_methods_classicu_1_1ByteSink"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flush internal buffers.  <a href="#ad8b12cabefa31cfcdd1dc166a9f829f2">More...</a><br/></td></tr>
<tr class="separator:ad8b12cabefa31cfcdd1dc166a9f829f2 inherit pub_methods_classicu_1_1ByteSink"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Implementation of <a class="el" href="classicu_1_1ByteSink.html" title="A ByteSink can be filled with bytes. ">ByteSink</a> that writes to a flat byte array, with bounds-checking: This sink will not write more than capacity bytes to outbuf. </p>
<p>If more than capacity bytes are <a class="el" href="classicu_1_1CheckedArrayByteSink.html#aa927725da1eec2f646f7be734d4d4c06" title="Append &quot;bytes[0,n-1]&quot; to this. ">Append()</a>ed, then excess bytes are ignored, and <a class="el" href="classicu_1_1CheckedArrayByteSink.html#ad14f1783aa30e2cea50ce063d26f37af" title="Returns true if any bytes were discarded, i.e., if there was an attempt to write more than &#39;capacity&#39;...">Overflowed()</a> will return true. Overflow does not cause a runtime error. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000050">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>

<p>Definition at line <a class="el" href="bytestream_8h_source.html#l00143">143</a> of file <a class="el" href="bytestream_8h_source.html">bytestream.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a2ad2fd80f945eb971384e704a24a4da4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">icu::CheckedArrayByteSink::CheckedArrayByteSink </td>
          <td>(</td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>outbuf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int32_t&#160;</td>
          <td class="paramname"><em>capacity</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Constructs a <a class="el" href="classicu_1_1ByteSink.html" title="A ByteSink can be filled with bytes. ">ByteSink</a> that will write to outbuf[0..capacity-1]. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">outbuf</td><td>buffer to write to </td></tr>
    <tr><td class="paramname">capacity</td><td>size of the buffer </td></tr>
  </table>
  </dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000057">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>

</div>
</div>
<a class="anchor" id="a2f00ab1d8ddcd922c65449ebb435bc04"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual icu::CheckedArrayByteSink::~CheckedArrayByteSink </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Destructor. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000058">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aa927725da1eec2f646f7be734d4d4c06"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void icu::CheckedArrayByteSink::Append </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>bytes</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int32_t&#160;</td>
          <td class="paramname"><em>n</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Append "bytes[0,n-1]" to this. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">bytes</td><td>the pointer to the bytes </td></tr>
    <tr><td class="paramname">n</td><td>the number of bytes; must be non-negative </td></tr>
  </table>
  </dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000060">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>

<p>Implements <a class="el" href="classicu_1_1ByteSink.html#a61fe994281322e8a3e3ed2e50c910e41">icu::ByteSink</a>.</p>

</div>
</div>
<a class="anchor" id="a20f2bd9b3666a6fcb9782a0015bc6c42"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual char* icu::CheckedArrayByteSink::GetAppendBuffer </td>
          <td>(</td>
          <td class="paramtype">int32_t&#160;</td>
          <td class="paramname"><em>min_capacity</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int32_t&#160;</td>
          <td class="paramname"><em>desired_capacity_hint</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>scratch</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int32_t&#160;</td>
          <td class="paramname"><em>scratch_capacity</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int32_t *&#160;</td>
          <td class="paramname"><em>result_capacity</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns a writable buffer for appending and writes the buffer's capacity to *result_capacity. </p>
<p>For details see the base class documentation. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">min_capacity</td><td>required minimum capacity of the returned buffer; must be non-negative </td></tr>
    <tr><td class="paramname">desired_capacity_hint</td><td>desired capacity of the returned buffer; must be non-negative </td></tr>
    <tr><td class="paramname">scratch</td><td>default caller-owned buffer </td></tr>
    <tr><td class="paramname">scratch_capacity</td><td>capacity of the scratch buffer </td></tr>
    <tr><td class="paramname">result_capacity</td><td>pointer to an integer which will be set to the capacity of the returned buffer </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a buffer with *result_capacity&gt;=min_capacity </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000061">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>

<p>Reimplemented from <a class="el" href="classicu_1_1ByteSink.html#a391838e3698a0132097ff2877565aaee">icu::ByteSink</a>.</p>

</div>
</div>
<a class="anchor" id="a3e70bb360869780ab3252b45ff1ea4d3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int32_t icu::CheckedArrayByteSink::NumberOfBytesAppended </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns the number of bytes appended to the sink. </p>
<p>If <a class="el" href="classicu_1_1CheckedArrayByteSink.html#ad14f1783aa30e2cea50ce063d26f37af" title="Returns true if any bytes were discarded, i.e., if there was an attempt to write more than &#39;capacity&#39;...">Overflowed()</a> then <a class="el" href="classicu_1_1CheckedArrayByteSink.html#a3e70bb360869780ab3252b45ff1ea4d3" title="Returns the number of bytes appended to the sink. ">NumberOfBytesAppended()</a>&gt;<a class="el" href="classicu_1_1CheckedArrayByteSink.html#a855275c60617b7c4732a12058e490331" title="Returns the number of bytes actually written to the sink. ">NumberOfBytesWritten()</a> else they return the same number. </p>
<dl class="section return"><dt>Returns</dt><dd>number of bytes written to the buffer </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000064">Stable:</a></b></dt><dd>ICU 4.6 </dd></dl>

<p>Definition at line <a class="el" href="bytestream_8h_source.html#l00211">211</a> of file <a class="el" href="bytestream_8h_source.html">bytestream.h</a>.</p>

</div>
</div>
<a class="anchor" id="a855275c60617b7c4732a12058e490331"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int32_t icu::CheckedArrayByteSink::NumberOfBytesWritten </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns the number of bytes actually written to the sink. </p>
<dl class="section return"><dt>Returns</dt><dd>number of bytes written to the buffer </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000062">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>

<p>Definition at line <a class="el" href="bytestream_8h_source.html#l00196">196</a> of file <a class="el" href="bytestream_8h_source.html">bytestream.h</a>.</p>

</div>
</div>
<a class="anchor" id="ad14f1783aa30e2cea50ce063d26f37af"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> icu::CheckedArrayByteSink::Overflowed </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns true if any bytes were discarded, i.e., if there was an attempt to write more than 'capacity' bytes. </p>
<dl class="section return"><dt>Returns</dt><dd>TRUE if more than 'capacity' bytes were <a class="el" href="classicu_1_1CheckedArrayByteSink.html#aa927725da1eec2f646f7be734d4d4c06" title="Append &quot;bytes[0,n-1]&quot; to this. ">Append()</a>ed </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000063">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>

<p>Definition at line <a class="el" href="bytestream_8h_source.html#l00203">203</a> of file <a class="el" href="bytestream_8h_source.html">bytestream.h</a>.</p>

</div>
</div>
<a class="anchor" id="abba65c7ce58ff4932a445660d6d6946e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classicu_1_1CheckedArrayByteSink.html">CheckedArrayByteSink</a>&amp; icu::CheckedArrayByteSink::Reset </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns the sink to its original state, without modifying the buffer. </p>
<p>Useful for reusing both the buffer and the sink for multiple streams. Resets the state to <a class="el" href="classicu_1_1CheckedArrayByteSink.html#a855275c60617b7c4732a12058e490331" title="Returns the number of bytes actually written to the sink. ">NumberOfBytesWritten()</a>=<a class="el" href="classicu_1_1CheckedArrayByteSink.html#a3e70bb360869780ab3252b45ff1ea4d3" title="Returns the number of bytes appended to the sink. ">NumberOfBytesAppended()</a>=0 and <a class="el" href="classicu_1_1CheckedArrayByteSink.html#ad14f1783aa30e2cea50ce063d26f37af" title="Returns true if any bytes were discarded, i.e., if there was an attempt to write more than &#39;capacity&#39;...">Overflowed()</a>=FALSE. </p>
<dl class="section return"><dt>Returns</dt><dd>*this </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000059">Stable:</a></b></dt><dd>ICU 4.6 </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="bytestream_8h_source.html">bytestream.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>