This interface provides the methods for handling lists that contain references to objects.
This interface offers all the methods of the IdmaList interface, as well as those listed below.
This method must be supported in every implementation of this interface.
Syntax
DmaRC IdmaListOfObject::GetObject (
DmaIndex32 iIndex,
DMA_REFIID riid,
pDmapv ppIObjectValue)
Parameters
Name | Mode | Description |
iIndex | input | The ordinal position in the list to retrieve the object from. |
riid | input | Interface Identifier for the desired interface on resulting object. |
ppIObjectValue | output | Returns a pointer to the interface of the returned object, which is set to NULL for unsuccessful return codes. |
This function will return the interface for the object that resides in the iIndex-th position in the list.
Valid values for iIndex are 0 through n-1, where n is the number of elements in the list at the time of the call.
If the returned object does not support the interface specified by riid, the operation will fail and the result code DMARC_BAD_INTERFACE will be returned. In case the operation is successful, the returned interface must be released using the method IUnknown::Release.
Return Values
Name | Description |
DMARC_BAD_INDEX | The index specified does not reference a valid property or list element. |
DMARC_BAD_INTERFACE | (E_NOINTERFACE) The requested interface is not supported by this object. |
DMARC_BAD_PARAMETER | (E_INVALIDARG) Invalid input parameter. |
DMARC_OBJECT_DELETED | The object has been deleted since it was retrieved. |
DMARC_OK | (S_OK) Success. |
DMARC_STALE_METADATA | The metadata in the persistent store has been changed so that it does not match the client's current copy of the metadata. |