Awa___ArrayIterator_GetValue

Return the value of the resource instance at the current index of the array contained in the input Array Iterator. More...

Functions
const char *	AwaCStringArrayIterator_GetValueAsCString (const AwaCStringArrayIterator *iterator)
AwaInteger	AwaIntegerArrayIterator_GetValue (const AwaIntegerArrayIterator *iterator)
AwaFloat	AwaFloatArrayIterator_GetValue (const AwaFloatArrayIterator *iterator)
AwaBoolean	AwaBooleanArrayIterator_GetValue (const AwaBooleanArrayIterator *iterator)
AwaOpaque	AwaOpaqueArrayIterator_GetValue (const AwaOpaqueArrayIterator *iterator)
AwaTime	AwaTimeArrayIterator_GetValue (const AwaTimeArrayIterator *iterator)
AwaObjectLink	AwaObjectLinkArrayIterator_GetValue (const AwaObjectLinkArrayIterator *iterator)

Detailed Description

Return the value of the resource instance at the current index of the array contained in the input Array Iterator.

Parameters

[in]

iterator

A pointer to a valid Array Iterator of the specified type.

Returns

the current index of the Array Iterator if the input Array Iterator is valid.

NULL if the input Array Iterator is invalid, or the iterator has reached the end of its array.

Function Documentation

const char* AwaCStringArrayIterator_GetValueAsCString

(

const AwaCStringArrayIterator *

iterator

)

AwaInteger AwaIntegerArrayIterator_GetValue

(

const AwaIntegerArrayIterator *

iterator

)

Examples:

client-get-array-example.c.

AwaFloat AwaFloatArrayIterator_GetValue

(

const AwaFloatArrayIterator *

iterator

)

AwaBoolean AwaBooleanArrayIterator_GetValue

(

const AwaBooleanArrayIterator *

iterator

)

AwaOpaque AwaOpaqueArrayIterator_GetValue

(

const AwaOpaqueArrayIterator *

iterator

)

AwaTime AwaTimeArrayIterator_GetValue

(

const AwaTimeArrayIterator *

iterator

)

AwaObjectLink AwaObjectLinkArrayIterator_GetValue

(

const AwaObjectLinkArrayIterator *

iterator

)