| title | CComDynamicUnkArray Class | Microsoft Docs | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ms.custom | ||||||||||||||
| ms.date | 11/04/2016 | |||||||||||||
| ms.reviewer | ||||||||||||||
| ms.suite | ||||||||||||||
| ms.technology |
|
|||||||||||||
| ms.tgt_pltfrm | ||||||||||||||
| ms.topic | reference | |||||||||||||
| f1_keywords |
|
|||||||||||||
| dev_langs |
|
|||||||||||||
| helpviewer_keywords |
|
|||||||||||||
| ms.assetid | 202470d7-9a1b-498f-b96d-659d681acd65 | |||||||||||||
| caps.latest.revision | 17 | |||||||||||||
| author | mikeblome | |||||||||||||
| ms.author | mblome | |||||||||||||
| manager | ghogen | |||||||||||||
| translation.priority.ht |
|
This class stores an array of IUnknown pointers.
class CComDynamicUnkArray
| Name | Description |
|---|---|
| CComDynamicUnkArray::CComDynamicUnkArray | Constructor. Initializes the collection values to NULL and the collection size to zero. |
| CComDynamicUnkArray::~CComDynamicUnkArray | The destructor. |
| Name | Description |
|---|---|
| CComDynamicUnkArray::Add | Call this method to add an IUnknown pointer to the array. |
| CComDynamicUnkArray::begin | Returns a pointer to the first IUnknown pointer in the collection. |
| CComDynamicUnkArray::clear | Empties the array. |
| CComDynamicUnkArray::end | Returns a pointer to one past the last IUnknown pointer in the collection. |
| CComDynamicUnkArray::GetAt | Retrieves the element at the specified index. |
| CComDynamicUnkArray::GetCookie | Call this method to get the cookie associated with a given IUnknown pointer. |
| CComDynamicUnkArray::GetSize | Returns the length of an array. |
| CComDynamicUnkArray::GetUnknown | Call this method to get the IUnknown pointer associated with a given cookie. |
| CComDynamicUnkArray::Remove | Call this method to remove an IUnknown pointer from the array. |
CComDynamicUnkArray holds a dynamically allocated array of IUnknown pointers, each an interface on a connection point. CComDynamicUnkArray can be used as a parameter to the IConnectionPointImpl template class.
The CComDynamicUnkArray methods begin and end can be used to loop through all connection points (for example, when an event is fired).
See Adding Connection Points to an Object for details on automating creation of connection point proxies.
Note
Note The class CComDynamicUnkArray is used by the Add Class wizard when creating a control which has Connection Points. If you wish to specify the number of Connection Points manually, change the reference from CComDynamicUnkArray to CComUnkArray< n >, where n is the number of connection points required.
Header: atlcom.h
Call this method to add an IUnknown pointer to the array.
DWORD Add(IUnknown* pUnk);
pUnk
The IUnknown pointer to add to the array.
Returns the cookie associated with the newly added pointer.
Returns a pointer to the beginning of the collection of IUnknown interface pointers.
IUnknown**
begin();
A pointer to an IUnknown interface pointer.
The collection contains pointers to interfaces stored locally as IUnknown. You cast each IUnknown interface to the real interface type and then call through it. You do not need to query for the interface first.
Before using the IUnknown interface, you should check that it is not NULL.
Empties the array.
void clear();
The constructor.
CComDynamicUnkArray();
Sets the collection size to zero and initializes the values to NULL. The destructor frees the collection, if necessary.
The destructor.
~CComDynamicUnkArray();
Frees resources allocated by the class constructor.
Returns a pointer to one past the last IUnknown pointer in the collection.
IUnknown**
end();
A pointer to an IUnknown interface pointer.
Retrieves the element at the specified index.
IUnknown* GetAt(int nIndex);
nIndex
The index of the element to retrieve.
A pointer to an IUnknown interface.
Call this method to get the cookie associated with a given IUnknown pointer.
DWORD WINAPI GetCookie(IUnknown** ppFind);
ppFind
The IUnknown pointer for which the associated cookie is required.
Returns the cookie associated with the IUnknown pointer, or zero if no matching IUnknown pointer is found.
If there is more than one instance of the same IUnknown pointer, this function returns the cookie for the first one.
Returns the length of an array.
int GetSize() const;
The length of the array.
Call this method to get the IUnknown pointer associated with a given cookie.
IUnknown* WINAPI GetUnknown(DWORD dwCookie);
dwCookie
The cookie for which the associated IUnknown pointer is required.
Returns the IUnknown pointer, or NULL if no matching cookie is found.
Call this method to remove an IUnknown pointer from the array.
BOOL Remove(DWORD dwCookie);
dwCookie
The cookie referencing the IUnknown pointer to be removed from the array.
Returns TRUE if the pointer is removed; otherwise FALSE.