| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Apache Geode Native .NET Reference: Apache::Geode::Client::CacheableStringArray 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="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(initResizable); |
| /* @license-end */</script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.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 id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Apache Geode Native .NET Reference |
|  <span id="projectnumber">1.13.0</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.15 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('a00526.html','');}); |
| /* @license-end */ |
| </script> |
| <div id="doc-content"> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </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 class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="#properties">Properties</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache::Geode::Client::CacheableStringArray Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>An immutable wrapper for array of strings that can serve as a distributable object for caching. |
| <a href="a00526.html#details">More...</a></p> |
| |
| <p>Inherits Apache::Geode::Client::IDataSerializablePrimitive.</p> |
| <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:ad51344d6c7760afadea09d1f5cf7825e"><td class="memItemLeft" align="right" valign="top">array< String^> ^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a00526.html#ad51344d6c7760afadea09d1f5cf7825e">GetValues</a> ()</td></tr> |
| <tr class="memdesc:ad51344d6c7760afadea09d1f5cf7825e"><td class="mdescLeft"> </td><td class="mdescRight">Returns a copy of the underlying array of strings. <a href="#ad51344d6c7760afadea09d1f5cf7825e">More...</a><br /></td></tr> |
| <tr class="separator:ad51344d6c7760afadea09d1f5cf7825e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a778f034e0dcec70fa8f9f18ba1546ee4"><td class="memItemLeft" align="right" valign="top">virtual String ^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a00526.html#a778f034e0dcec70fa8f9f18ba1546ee4">ToString</a> () override</td></tr> |
| <tr class="memdesc:a778f034e0dcec70fa8f9f18ba1546ee4"><td class="mdescLeft"> </td><td class="mdescRight">Return a string representation of the object. <a href="#a778f034e0dcec70fa8f9f18ba1546ee4">More...</a><br /></td></tr> |
| <tr class="separator:a778f034e0dcec70fa8f9f18ba1546ee4"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a91da35ad483a324265db49952c7420f9"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00526.html">CacheableStringArray</a> ^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a00526.html#a91da35ad483a324265db49952c7420f9">Create</a> (array< String^>^ strings)</td></tr> |
| <tr class="memdesc:a91da35ad483a324265db49952c7420f9"><td class="mdescLeft"> </td><td class="mdescRight">Static function to create a new instance copying from the given string array. <a href="#a91da35ad483a324265db49952c7420f9">More...</a><br /></td></tr> |
| <tr class="separator:a91da35ad483a324265db49952c7420f9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afa676b74e0c435b2a7d9086926936f39"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a01022.html">ISerializable</a> ^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a00526.html#afa676b74e0c435b2a7d9086926936f39">CreateDeserializable</a> ()</td></tr> |
| <tr class="memdesc:afa676b74e0c435b2a7d9086926936f39"><td class="mdescLeft"> </td><td class="mdescRight">Factory function to register this class. <a href="#afa676b74e0c435b2a7d9086926936f39">More...</a><br /></td></tr> |
| <tr class="separator:afa676b74e0c435b2a7d9086926936f39"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a> |
| Properties</h2></td></tr> |
| <tr class="memitem:ae3a408047bc5078894a1a70bc1a6322c"><td class="memItemLeft" align="right" valign="top">String^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a00526.html#ae3a408047bc5078894a1a70bc1a6322c">Item</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ae3a408047bc5078894a1a70bc1a6322c"><td class="mdescLeft"> </td><td class="mdescRight">Returns a copy of the underlying string at the given index. <a href="#ae3a408047bc5078894a1a70bc1a6322c">More...</a><br /></td></tr> |
| <tr class="separator:ae3a408047bc5078894a1a70bc1a6322c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4f9db8bbe81e2410470baa8988846305"><td class="memItemLeft" align="right" valign="top">System::Int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="a00526.html#a4f9db8bbe81e2410470baa8988846305">Length</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a4f9db8bbe81e2410470baa8988846305"><td class="mdescLeft"> </td><td class="mdescRight">Gets the length of the array. <a href="#a4f9db8bbe81e2410470baa8988846305">More...</a><br /></td></tr> |
| <tr class="separator:a4f9db8bbe81e2410470baa8988846305"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>An immutable wrapper for array of strings that can serve as a distributable object for caching. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a91da35ad483a324265db49952c7420f9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a91da35ad483a324265db49952c7420f9">◆ </a></span>Create()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="a00526.html">CacheableStringArray</a> ^ Apache::Geode::Client::CacheableStringArray::Create </td> |
| <td>(</td> |
| <td class="paramtype">array< String^>^ </td> |
| <td class="paramname"><em>strings</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Static function to create a new instance copying from the given string array. </p> |
| <p>If the given array of strings is null or of zero-length then this method returns null. </p> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00634.html" title="Thrown when an argument to a method is illegal.">IllegalArgumentException</a></td><td>If the array contains a string greater than or equal 64K in length. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="afa676b74e0c435b2a7d9086926936f39"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afa676b74e0c435b2a7d9086926936f39">◆ </a></span>CreateDeserializable()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="a01022.html">ISerializable</a> ^ Apache::Geode::Client::CacheableStringArray::CreateDeserializable </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Factory function to register this class. </p> |
| |
| </div> |
| </div> |
| <a id="ad51344d6c7760afadea09d1f5cf7825e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad51344d6c7760afadea09d1f5cf7825e">◆ </a></span>GetValues()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">array<String^> ^ Apache::Geode::Client::CacheableStringArray::GetValues </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns a copy of the underlying array of strings. </p> |
| |
| </div> |
| </div> |
| <a id="a778f034e0dcec70fa8f9f18ba1546ee4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a778f034e0dcec70fa8f9f18ba1546ee4">◆ </a></span>ToString()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual String ^ Apache::Geode::Client::CacheableStringArray::ToString </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Return a string representation of the object. </p> |
| |
| <p>Implements <a class="el" href="a01022.html#a335290fd15fd41d39bc73a7ca10d19bd">Apache::Geode::Client::ISerializable</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="ae3a408047bc5078894a1a70bc1a6322c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae3a408047bc5078894a1a70bc1a6322c">◆ </a></span>Item</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">String^ Apache::Geode::Client::CacheableStringArray::Item</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns a copy of the underlying string at the given index. </p> |
| |
| </div> |
| </div> |
| <a id="a4f9db8bbe81e2410470baa8988846305"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4f9db8bbe81e2410470baa8988846305">◆ </a></span>Length</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">System:: Int32 Apache::Geode::Client::CacheableStringArray::Length</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the length of the array. </p> |
| |
| </div> |
| </div> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| http://www.apache.org/licenses/LICENSE-2.0 |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| <HR><address style="align: right;"><small>Apache Geode C++ Cache .NET API Documentation</small></address> |
