IConnectionManager::GetNextConnectionID (Compact 7)
3/12/2014
This iterator method returns a connection ID for a connection managed by this ConnectionManager instance. Subsequent calls to this method return additional connection IDs. Before using this method, call IConnectionManager::GetFirstConnectionID to initialize the iterator and retrieve the first connection ID.
Syntax
virtual DWORD GetNextConnectionID(
long* pConnectionID
) = 0;
Parameters
- pConnectionID
[in, out] Pointer to an integer allocated by the caller which this method modifies to contain the next connection ID. Does not correspond directly to a state variable because of use of an iterator model with GetFirstConnectionID. Related to the CurrentConnectionIDs state variable.
Return Value
Custom implementations can return appropriate error codes. Should return SUCCESS_AV if the method succeeds. Otherwise, should return an error code defined in WinError.h or UPnP.h, or one of the UPnP AV-specific return values specified in UPnPAVError.
The implementation of this method in IConnectionManagerImpl returns these errors:
Value | Description |
---|---|
ERROR_AV_POINTER |
The pConnectionID pointer is NULL. |
ERROR_AV_NO_MORE_ITEMS |
There are no more connection IDs to return. |
SUCCESS_AV |
The next connection ID was returned. |
Remarks
This method and GetFirstConnectionID combined correspond to the ConnectionManager service's GetCurrentConnectionIDs action.
For more information about the actions in the ConnectionManager service, see the UPnP Forum AV web site.
Requirements
Header |
av_upnp.h |
Library |
Av_upnp.lib |
See Also
Reference
IConnectionManager
IConnectionManager::GetFirstConnectionID
IConnectionManagerImpl
UPnPAVError