Share via

IConnectionManager::GetNextConnectionID

  • Article

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

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 UPnP AV DCP Documentation.

Requirements

Header av_upnp.h
Library Av_upnp.lib
Windows Embedded CE Windows CE 5.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

IConnectionManager
IConnectionManager::GetFirstConnectionID
IConnectionManagerImpl
UPnPAVError