ArrayInterface.h File Reference

Interface for TObjPtrArray wrapper. More...

Go to the source code of this file.

Functions
IDRS_UINT	ArrayInterface_GetCount (ArrayInterface pargArray, idrs_exception *pargException)
IDRS_UINT64	ArrayInterface_GetHash (ArrayInterface pargArray, idrs_exception *pargException)
struct idrsObject *	ArrayInterface_GetAt (ArrayInterface pargArray, IDRS_UINT uiIndex, idrs_exception *pargException)
void	ArrayInterface_SetAt (ArrayInterface pargArray, IDRS_UINT uiIndex, struct idrsObject *toSet, idrs_exception *pargException)
void	ArrayInterface_AddTail (ArrayInterface pargArray, struct idrsObject *toAdd, idrs_exception *pargException)
void	ArrayInterface_InsertAt (ArrayInterface pargArray, IDRS_UINT uiIndex, struct idrsObject *toInsert, idrs_exception *pargException)
void	ArrayInterface_RemoveAt (ArrayInterface pargArray, IDRS_UINT uiFirstEltIndex, IDRS_UINT uiCount, idrs_exception *pargException)
void	ArrayInterface_RemoveAll (ArrayInterface pargArray, idrs_exception *pargException)
void	ArrayInterface_Destroy (ArrayInterface pargArray, idrs_exception *pargException)
	Destroys a ArrayInterface handle.

Detailed Description

Interface for TObjPtrArray wrapper.

Function Documentation

ArrayInterface_AddTail()

void ArrayInterface_AddTail	(	ArrayInterface	pargArray,
		struct idrsObject *	toAdd,
		idrs_exception *	pargException
	)

Adds the given element at the end of the array.

Parameters

pargArray	ArrayInterface handle
toAdd	The element to add.
pargException	Pointer to exception structure that will be filled if an exception occurs

ArrayInterface_Destroy()

void ArrayInterface_Destroy	(	ArrayInterface	pargArray,
		idrs_exception *	pargException
	)

Destroys a ArrayInterface handle.

Parameters

pargArray	ArrayInterface handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

ArrayInterface_GetAt()

struct idrsObject * ArrayInterface_GetAt	(	ArrayInterface	pargArray,
		IDRS_UINT	uiIndex,
		idrs_exception *	pargException
	)

Parameters

pargArray	ArrayInterface handle
uiIndex	The index of the element to retrieve.
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

The element at the given index.

ArrayInterface_GetCount()

IDRS_UINT ArrayInterface_GetCount	(	ArrayInterface	pargArray,
		idrs_exception *	pargException
	)

Returns

The count of elements in the array.

Parameters

pargArray	ArrayInterface handle
pargException	Pointer to exception structure that will be filled if an exception occurs

ArrayInterface_GetHash()

IDRS_UINT64 ArrayInterface_GetHash	(	ArrayInterface	pargArray,
		idrs_exception *	pargException
	)

Returns

The a value representing the hash of elements in the array. Useful for detecting changes in the array

Parameters

pargArray	ArrayInterface handle
pargException	Pointer to exception structure that will be filled if an exception occurs

ArrayInterface_InsertAt()

void ArrayInterface_InsertAt	(	ArrayInterface	pargArray,
		IDRS_UINT	uiIndex,
		struct idrsObject *	toInsert,
		idrs_exception *	pargException
	)

Inserts an element in the array.

Parameters

pargArray	ArrayInterface handle
uiIndex	The index where to insert the element.
toInsert	The element to insert.
pargException	Pointer to exception structure that will be filled if an exception occurs

ArrayInterface_RemoveAll()

void ArrayInterface_RemoveAll	(	ArrayInterface	pargArray,
		idrs_exception *	pargException
	)

Removes all the elements from the array.

Parameters

pargArray	ArrayInterface handle
pargException	Pointer to exception structure that will be filled if an exception occurs

ArrayInterface_RemoveAt()

void ArrayInterface_RemoveAt	(	ArrayInterface	pargArray,
		IDRS_UINT	uiFirstEltIndex,
		IDRS_UINT	uiCount,
		idrs_exception *	pargException
	)

Removes the elements starting at the given index.

Parameters

pargArray	ArrayInterface handle
uiFirstEltIndex	The index of the first element to remove.
uiCount	The number of elements to remove.
pargException	Pointer to exception structure that will be filled if an exception occurs

ArrayInterface_SetAt()

void ArrayInterface_SetAt	(	ArrayInterface	pargArray,
		IDRS_UINT	uiIndex,
		struct idrsObject *	toSet,
		idrs_exception *	pargException
	)

Replaces the element at the given index.

Parameters

pargArray	ArrayInterface handle
uiIndex	The index of the element to replace.
toSet	The element to place in the array.
pargException	Pointer to exception structure that will be filled if an exception occurs