IDDEActiveServerSet

The IDDEActiverServerSet class is a set. The set contains pointers to IDDEActiveServer objects.

An application creates an object of this class to use with the IDDEClientConversation::supportingApplications or IDDEClientConversation::supportedTopics function to hold the current set of active servers. If you remove individual elements of this set, delete the IDDEActiveServer object to which the element points or the memory is not recovered.


IDDEActiveServerSet - Member Functions and Data by Group

Constructors & Destructor

Use these to construct and destruct objects of this class.


[view class]
~IDDEActiveServerSet
public:
~IDDEActiveServerSet()

This function removes all the elements from the set and deletes them.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


[view class]
IDDEActiveServerSet
public:
IDDEActiveServerSet()

You can construct an object of this class using the default constructor, which does not accept any arguments.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


Addition and Removal

Use these functions to add and remove IDDEActiveServer objects.


[view class]
add
public:
bool add(IDDEActiveServer * const& activeServer)

Adds the IDDEActiveServer object as the last element in the collection.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


[view class]
removeAll

Removes all IDDEActiveServer objects from the collection.


Overload 1
public:
unsigned long removeAll()

Supported Platforms

Windows OS/2 AIX
Yes Yes No


Overload 2
public:
unsigned long removeAll( bool ( * predicateFunction ) ( IDDEActiveServer * const&, void * ) , void* data = 0 )

Supported Platforms

Windows OS/2 AIX
Yes Yes No


[view class]
removeAt
public:
void removeAt(Cursor& cursor)

Removes theIDDEActiveServer object at the given cursor.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


[view class]
replaceAt
public:
void replaceAt( const Cursor& cursor, IDDEActiveServer * const& activeServer )

Replaces the IDDEActiveServer object at the given cursor with the given IDDEActiveServer object.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


Iteration

Use these functions to operate on all objects in the collection.


[view class]
allElementsDo
public:
bool allElementsDo( bool ( * function ) ( IDDEActiveServer *&, void * ) , void* additionalArgument = 0 )

Calls the specified function for each object in the set.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


Query

Use these functions to determine characteristics of the collection.


[view class]
elementAt
public:
IDDEActiveServer* elementAt(const Cursor& cursor) const

Returns the IDDEActiveServer object pointed to by the given cursor.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


[view class]
isEmpty
public:
bool isEmpty() const

Returns true if the collection of IDDEActiveServer objects is empty.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


[view class]
numberOfElements
public:
unsigned long numberOfElements() const

Returns the number of IDDEActiveServer objects in the collection.

Supported Platforms

Windows OS/2 AIX
Yes Yes No


IDDEActiveServerSet - Inherited Member Functions and Data

Inherited Public Functions

Inherited Public Data

Inherited Protected Functions

Inherited Protected Data