sae.SubscriberIterator Interface Reference

import "saeaccess.idl";

List of all members.

---

Detailed Description

Interface that is used to iteratively retrieve subscriber objects that were not transmitted from a single API call to the SAE.

NOTE: If the SubscriberIterator is not used for an allotted time, the garbage collector takes care of it.

Public Member Functions
SubscriberSeq	next_n (in unsigned long how_many, out boolean more)
	The next_n() method retrieves the next N number of subscriber objects.
void	destroy ()
	The destroy () method stops the SubscriberIterator() method and frees associated memory.

---

Member Function Documentation

void sae.SubscriberIterator.destroy

(

)

The destroy () method stops the SubscriberIterator() method and frees associated memory.

SubscriberSeq sae.SubscriberIterator.next_n	(	in unsigned long	how_many,
		out boolean	more
	)

The next_n() method retrieves the next N number of subscriber objects.

Parameters:

[in]	how_many	Maximum number of subscriber objects to return.
[out]	more	True when there are more subscriber objects to retrieve. False when all subscriber objects have been retrieved.

Returns:

Sequence of subscriber objects.

---

The documentation for this interface was generated from the following file:

• saeaccess.idl

---