| <!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::StructSet< TResult > Class Template 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('a01118.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="#properties">Properties</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache::Geode::Client::StructSet< TResult > Class Template Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Encapsulates a query struct set. |
| <a href="a01118.html#details">More...</a></p> |
| |
| <p>Inherits <a class="el" href="a00582.html">Apache::Geode::Client::ICqResults< TResult ></a>.</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:a8249a5a1a26b608da8d67c34a8637647"><td class="memItemLeft" align="right" valign="top">virtual System::Collections::Generic::IEnumerator< TResult > ^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a01118.html#a8249a5a1a26b608da8d67c34a8637647">GetEnumerator</a> ()</td></tr> |
| <tr class="memdesc:a8249a5a1a26b608da8d67c34a8637647"><td class="mdescLeft"> </td><td class="mdescRight">Returns an enumerator that iterates through the <code><a class="el" href="a01118.html" title="Encapsulates a query struct set.">StructSet</a></code>. <a href="#a8249a5a1a26b608da8d67c34a8637647">More...</a><br /></td></tr> |
| <tr class="separator:a8249a5a1a26b608da8d67c34a8637647"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abf4f0e50957c0c8677592d65a80f2312"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a01118.html#abf4f0e50957c0c8677592d65a80f2312">GetFieldIndex</a> (String^ fieldName)</td></tr> |
| <tr class="memdesc:abf4f0e50957c0c8677592d65a80f2312"><td class="mdescLeft"> </td><td class="mdescRight">Get the index number of the specified field name in the <code><a class="el" href="a01118.html" title="Encapsulates a query struct set.">StructSet</a></code>. <a href="#abf4f0e50957c0c8677592d65a80f2312">More...</a><br /></td></tr> |
| <tr class="separator:abf4f0e50957c0c8677592d65a80f2312"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6bc0295f66a9fc7be8278d4e64d91688"><td class="memItemLeft" align="right" valign="top">String ^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a01118.html#a6bc0295f66a9fc7be8278d4e64d91688">GetFieldName</a> (int32_t index)</td></tr> |
| <tr class="memdesc:a6bc0295f66a9fc7be8278d4e64d91688"><td class="mdescLeft"> </td><td class="mdescRight">Get the field name of the <code><a class="el" href="a01118.html" title="Encapsulates a query struct set.">StructSet</a></code> from the specified index number. <a href="#a6bc0295f66a9fc7be8278d4e64d91688">More...</a><br /></td></tr> |
| <tr class="separator:a6bc0295f66a9fc7be8278d4e64d91688"><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:aaebabd2cb18901cdcf7501b68f1c7698"><td class="memItemLeft" align="right" valign="top">virtual TResult </td><td class="memItemRight" valign="bottom"><a class="el" href="a01118.html#aaebabd2cb18901cdcf7501b68f1c7698">Item</a><code> [get]</code></td></tr> |
| <tr class="memdesc:aaebabd2cb18901cdcf7501b68f1c7698"><td class="mdescLeft"> </td><td class="mdescRight">Index operator to directly access an item in the <code><a class="el" href="a01118.html" title="Encapsulates a query struct set.">StructSet</a></code>. <a href="#aaebabd2cb18901cdcf7501b68f1c7698">More...</a><br /></td></tr> |
| <tr class="separator:aaebabd2cb18901cdcf7501b68f1c7698"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5887bc9f1602fb8ed37b7f3239b5df47"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a01118.html#a5887bc9f1602fb8ed37b7f3239b5df47">Size</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a5887bc9f1602fb8ed37b7f3239b5df47"><td class="mdescLeft"> </td><td class="mdescRight">The size of the <code><a class="el" href="a01118.html" title="Encapsulates a query struct set.">StructSet</a></code>. <a href="#a5887bc9f1602fb8ed37b7f3239b5df47">More...</a><br /></td></tr> |
| <tr class="separator:a5887bc9f1602fb8ed37b7f3239b5df47"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><h3>template<class TResult><br /> |
| class Apache::Geode::Client::StructSet< TResult ></h3> |
| |
| <p>Encapsulates a query struct set. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a8249a5a1a26b608da8d67c34a8637647"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8249a5a1a26b608da8d67c34a8637647">◆ </a></span>GetEnumerator()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TResult > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual System::Collections::Generic::IEnumerator<TResult> ^ <a class="el" href="a01118.html">Apache::Geode::Client::StructSet</a>< TResult >::GetEnumerator </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 an enumerator that iterates through the <code><a class="el" href="a01118.html" title="Encapsulates a query struct set.">StructSet</a></code>. </p> |
| <dl class="section return"><dt>Returns</dt><dd>A <code>System.Collections.Generic.IEnumerator</code> that can be used to iterate through the <code><a class="el" href="a01118.html" title="Encapsulates a query struct set.">StructSet</a></code>. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="abf4f0e50957c0c8677592d65a80f2312"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abf4f0e50957c0c8677592d65a80f2312">◆ </a></span>GetFieldIndex()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TResult > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int32_t <a class="el" href="a01118.html">Apache::Geode::Client::StructSet</a>< TResult >::GetFieldIndex </td> |
| <td>(</td> |
| <td class="paramtype">String^ </td> |
| <td class="paramname"><em>fieldName</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the index number of the specified field name in the <code><a class="el" href="a01118.html" title="Encapsulates a query struct set.">StructSet</a></code>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">fieldName</td><td>the field name for which the index is required. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the index number of the specified field name.</dd></dl> |
| <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 field name is not found. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a6bc0295f66a9fc7be8278d4e64d91688"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6bc0295f66a9fc7be8278d4e64d91688">◆ </a></span>GetFieldName()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TResult > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">String ^ <a class="el" href="a01118.html">Apache::Geode::Client::StructSet</a>< TResult >::GetFieldName </td> |
| <td>(</td> |
| <td class="paramtype">int32_t </td> |
| <td class="paramname"><em>index</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the field name of the <code><a class="el" href="a01118.html" title="Encapsulates a query struct set.">StructSet</a></code> from the specified index number. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">index</td><td>the index number of the field name to get. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the field name from the specified index number or null if not found. </dd></dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="aaebabd2cb18901cdcf7501b68f1c7698"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aaebabd2cb18901cdcf7501b68f1c7698">◆ </a></span>Item</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TResult > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual TResult <a class="el" href="a01118.html">Apache::Geode::Client::StructSet</a>< TResult >::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>Index operator to directly access an item in the <code><a class="el" href="a01118.html" title="Encapsulates a query struct set.">StructSet</a></code>. </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 index is out of bounds. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Item at the given index.</dd></dl> |
| |
| </div> |
| </div> |
| <a id="a5887bc9f1602fb8ed37b7f3239b5df47"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5887bc9f1602fb8ed37b7f3239b5df47">◆ </a></span>Size</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TResult > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual size_t <a class="el" href="a01118.html">Apache::Geode::Client::StructSet</a>< TResult >::Size</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>The size of the <code><a class="el" href="a01118.html" title="Encapsulates a query struct set.">StructSet</a></code>. </p> |
| <dl class="section return"><dt>Returns</dt><dd>the number of items in the <code><a class="el" href="a01118.html" title="Encapsulates a query struct set.">StructSet</a></code>. </dd></dl> |
| |
| </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> |
