Apache Geode Native .NET Reference  1.14.0
Apache::Geode::Client::StructSet< TResult > Class Template Reference

Encapsulates a query struct set. More...

Inherits Apache::Geode::Client::ICqResults< TResult >.

Public Member Functions

virtual System::Collections::Generic::IEnumerator< TResult > ^ GetEnumerator ()
 Returns an enumerator that iterates through the StructSet. More...
 
int32_t GetFieldIndex (String^ fieldName)
 Get the index number of the specified field name in the StructSet. More...
 
String ^ GetFieldName (int32_t index)
 Get the field name of the StructSet from the specified index number. More...
 

Properties

virtual TResult Item [get]
 Index operator to directly access an item in the StructSet. More...
 
virtual size_t Size [get]
 The size of the StructSet. More...
 

Detailed Description

template<class TResult>
class Apache::Geode::Client::StructSet< TResult >

Encapsulates a query struct set.

Member Function Documentation

◆ GetEnumerator()

template<class TResult >
virtual System::Collections::Generic::IEnumerator<TResult> ^ Apache::Geode::Client::StructSet< TResult >::GetEnumerator ( )
virtual

Returns an enumerator that iterates through the StructSet.

Returns
A System.Collections.Generic.IEnumerator that can be used to iterate through the StructSet.

◆ GetFieldIndex()

template<class TResult >
int32_t Apache::Geode::Client::StructSet< TResult >::GetFieldIndex ( String^  fieldName)

Get the index number of the specified field name in the StructSet.

Parameters
fieldNamethe field name for which the index is required.
Returns
the index number of the specified field name.
Exceptions
IllegalArgumentExceptionif the field name is not found.

◆ GetFieldName()

template<class TResult >
String ^ Apache::Geode::Client::StructSet< TResult >::GetFieldName ( int32_t  index)

Get the field name of the StructSet from the specified index number.

Parameters
indexthe index number of the field name to get.
Returns
the field name from the specified index number or null if not found.

Property Documentation

◆ Item

template<class TResult >
virtual TResult Apache::Geode::Client::StructSet< TResult >::Item
get

Index operator to directly access an item in the StructSet.

Exceptions
IllegalArgumentExceptionif the index is out of bounds.
Returns
Item at the given index.

◆ Size

template<class TResult >
virtual size_t Apache::Geode::Client::StructSet< TResult >::Size
get

The size of the StructSet.

Returns
the number of items in the StructSet.

Apache Geode C++ Cache .NET API Documentation