blob: e496a297bee54686129c8dc18396d5a9abad2fec [file] [log] [blame]
<!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::Struct 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&amp;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
&#160;<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&amp;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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('a01122.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> &#124;
<a href="#properties">Properties</a> </div>
<div class="headertitle">
<div class="title">Apache::Geode::Client::Struct Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Encapsulates a row of query struct set.
<a href="a01122.html#details">More...</a></p>
<p>Inherits <a class="el" href="a01114.html">Apache::Geode::Client::Serializable</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:aab399122dadac5f60090908915eb174e"><td class="memItemLeft" align="right" valign="top">virtual String ^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01114.html#aab399122dadac5f60090908915eb174e">ToString</a> () override</td></tr>
<tr class="memdesc:aab399122dadac5f60090908915eb174e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a string representation of the object. <a href="#aab399122dadac5f60090908915eb174e">More...</a><br /></td></tr>
<tr class="separator:aab399122dadac5f60090908915eb174e"><td class="memSeparator" colspan="2">&#160;</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:aeadb0e777952352dd109ffa9910b5502"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01122.html#aeadb0e777952352dd109ffa9910b5502">Count</a><code> [get]</code></td></tr>
<tr class="memdesc:aeadb0e777952352dd109ffa9910b5502"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number of field values available. <a href="#aeadb0e777952352dd109ffa9910b5502">More...</a><br /></td></tr>
<tr class="separator:aeadb0e777952352dd109ffa9910b5502"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac090952a8515f8d4f3aa05a6eb074cc7"><td class="memItemLeft" align="right" valign="top">Object^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01122.html#ac090952a8515f8d4f3aa05a6eb074cc7">Item</a><code> [get]</code></td></tr>
<tr class="memdesc:ac090952a8515f8d4f3aa05a6eb074cc7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the field value for the given index number. <a href="#ac090952a8515f8d4f3aa05a6eb074cc7">More...</a><br /></td></tr>
<tr class="separator:ac090952a8515f8d4f3aa05a6eb074cc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af073822a47dac5d41afb64df6ad52fee"><td class="memItemLeft" align="right" valign="top">virtual System::UInt64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01114.html#af073822a47dac5d41afb64df6ad52fee">ObjectSize</a><code> [get]</code></td></tr>
<tr class="memdesc:af073822a47dac5d41afb64df6ad52fee"><td class="mdescLeft">&#160;</td><td class="mdescRight">return the size of this object in bytes <a href="#af073822a47dac5d41afb64df6ad52fee">More...</a><br /></td></tr>
<tr class="separator:af073822a47dac5d41afb64df6ad52fee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace80a417cdad26d1708d488cb7a479bd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a01118.html">Apache::Geode::Client::StructSet</a>&lt; Object^&gt;^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01122.html#ace80a417cdad26d1708d488cb7a479bd">Set</a><code> [get]</code></td></tr>
<tr class="memdesc:ace80a417cdad26d1708d488cb7a479bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the parent <code><a class="el" href="a01118.html" title="Encapsulates a query struct set.">StructSet</a></code> of this <code><a class="el" href="a01122.html" title="Encapsulates a row of query struct set.">Struct</a></code>. <a href="#ace80a417cdad26d1708d488cb7a479bd">More...</a><br /></td></tr>
<tr class="separator:ace80a417cdad26d1708d488cb7a479bd"><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>Encapsulates a row of query struct set. </p>
<p>A <a class="el" href="a01122.html" title="Encapsulates a row of query struct set.">Struct</a> has a <a class="el" href="a01118.html" title="Encapsulates a query struct set.">StructSet</a> as its parent. It contains the field values returned after executing a <a class="el" href="a00586.html" title="Class to encapsulate a query.">Query</a> obtained from a <a class="el" href="a01086.html" title="Provides a query service.">QueryService</a> which in turn is obtained from a <a class="el" href="a00410.html" title="Provides a distributed cache.">Cache</a>. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aab399122dadac5f60090908915eb174e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab399122dadac5f60090908915eb174e">&#9670;&nbsp;</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::Serializable::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">override</span><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a string representation of the object. </p>
<p>It simply returns the string representation of the underlying native object by calling its <code>toString()</code> function. </p>
<p>Implements <a class="el" href="a01022.html#a335290fd15fd41d39bc73a7ca10d19bd">Apache::Geode::Client::ISerializable</a>.</p>
<p>Reimplemented in <a class="el" href="a00522.html#a5bbf6e7b40afcdb5f34d7c26fb14b5ca">Apache::Geode::Client::CacheableString</a>, <a class="el" href="a00418.html#a93998b074515d5609416e8a633e71333">Apache::Geode::Client::CacheableBuiltinKey&lt; TNative, TManaged, TYPEID &gt;</a>, <a class="el" href="a00418.html#a93998b074515d5609416e8a633e71333">Apache::Geode::Client::CacheableBuiltinKey&lt; native::CacheableInt32, System::Int32, static_cast&lt; int8_t &gt;(DSCode::CacheableInt32)&gt;</a>, <a class="el" href="a00418.html#a93998b074515d5609416e8a633e71333">Apache::Geode::Client::CacheableBuiltinKey&lt; native::CacheableInt16, System::Int16, static_cast&lt; int8_t &gt;(DSCode::CacheableInt16)&gt;</a>, <a class="el" href="a00418.html#a93998b074515d5609416e8a633e71333">Apache::Geode::Client::CacheableBuiltinKey&lt; native::CacheableCharacter, Char, static_cast&lt; int8_t &gt;(DSCode::CacheableCharacter)&gt;</a>, <a class="el" href="a00418.html#a93998b074515d5609416e8a633e71333">Apache::Geode::Client::CacheableBuiltinKey&lt; native::CacheableFloat, Single, static_cast&lt; int8_t &gt;(DSCode::CacheableFloat)&gt;</a>, <a class="el" href="a00418.html#a93998b074515d5609416e8a633e71333">Apache::Geode::Client::CacheableBuiltinKey&lt; native::CacheableInt64, System::Int64, static_cast&lt; int8_t &gt;(DSCode::CacheableInt64)&gt;</a>, <a class="el" href="a00418.html#a93998b074515d5609416e8a633e71333">Apache::Geode::Client::CacheableBuiltinKey&lt; native::CacheableDouble, Double, static_cast&lt; int8_t &gt;(DSCode::CacheableDouble)&gt;</a>, <a class="el" href="a00418.html#a93998b074515d5609416e8a633e71333">Apache::Geode::Client::CacheableBuiltinKey&lt; native::CacheableByte, Byte, static_cast&lt; int8_t &gt;(DSCode::CacheableByte)&gt;</a>, and <a class="el" href="a00418.html#a93998b074515d5609416e8a633e71333">Apache::Geode::Client::CacheableBuiltinKey&lt; native::CacheableBoolean, bool, static_cast&lt; int8_t &gt;(DSCode::CacheableBoolean)&gt;</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a id="aeadb0e777952352dd109ffa9910b5502"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeadb0e777952352dd109ffa9910b5502">&#9670;&nbsp;</a></span>Count</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int32_t Apache::Geode::Client::Struct::Count</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>Get the number of field values available. </p>
<dl class="section return"><dt>Returns</dt><dd>the number of field values available.</dd></dl>
</div>
</div>
<a id="ac090952a8515f8d4f3aa05a6eb074cc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac090952a8515f8d4f3aa05a6eb074cc7">&#9670;&nbsp;</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">Object Apache::Geode::Client::Struct::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>Get the field value for the given index number. </p>
<p>Get the field value for the given field name.</p>
<dl class="section return"><dt>Returns</dt><dd>The value of the field or null if index is out of bounds. </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>The value of the field.</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="af073822a47dac5d41afb64df6ad52fee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af073822a47dac5d41afb64df6ad52fee">&#9670;&nbsp;</a></span>ObjectSize</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual System:: UInt64 Apache::Geode::Client::Serializable::ObjectSize</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>return the size of this object in bytes </p>
</div>
</div>
<a id="ace80a417cdad26d1708d488cb7a479bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace80a417cdad26d1708d488cb7a479bd">&#9670;&nbsp;</a></span>Set</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Apache:: Geode:: Client:: <a class="el" href="a01118.html">StructSet</a>&lt; Object^&gt;^ Apache::Geode::Client::Struct::Set</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>Get the parent <code><a class="el" href="a01118.html" title="Encapsulates a query struct set.">StructSet</a></code> of this <code><a class="el" href="a01122.html" title="Encapsulates a row of query struct set.">Struct</a></code>. </p>
<dl class="section return"><dt>Returns</dt><dd>A reference to the parent <code><a class="el" href="a01118.html" title="Encapsulates a query struct set.">StructSet</a></code> of this <code><a class="el" href="a01122.html" title="Encapsulates a row of query struct set.">Struct</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>