Important: |
---|
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist. |
This method returns the protocol information, including network and content format data, supported by this ConnectionManager instance.
Syntax
virtual DWORD GetProtocolInfo( wstring* pstrSourceProtocolInfo, wstring* pstrSinkProtocolInfo ) = 0; |
Parameters
- pstrSourceProtocolInfo
-
[in, out] Pointer to a string that, upon return, contains a comma-separated list of protocol information supported by this ConnectionManager instance for sending media. Corresponds to the SourceProtocolInfo state variable.
- pstrSinkProtocolInfo
-
[in, out] Pointer to a string that, upon return, contains a comma-separated list of protocol information supported by this ConnectionManager instance for receiving media. Corresponds to the SinkProtocolInfo state variable.
Return Value
Custom implementations can return appropriate error codes. If this method succeeeds, it should return SUCCESS_AV. Otherwise, it 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 IConnectionManagerImplreturns these errors:
Value | Description |
---|---|
ERROR_AV_POINTER |
Either of the pstrSourceProtocolInfoor pstrSinkProtocolInfoparameters are NULL. |
ERROR_AV_OOM |
There was not enough memory to return protocol information strings. |
SUCCESS_AV |
Protocol information strings were returned correctly. |
Remarks
This method corresponds to the ConnectionManager service's GetProtocolInfo action.
The IConnectionManagerImplclass provides the following methods to enable developers to maintain protocol information for a particular ConnectionManager instance.
-
IConnectionManagerImpl::AddSinkProtocol
-
IConnectionManagerImpl::AddSourceProtocol
-
IConnectionManagerImpl::RemoveSinkProtocol
-
IConnectionManagerImpl::RemoveSourceProtocol
The provided implementation of this method builds the protocol information strings using information provided by these methods.
For more information about the actions in the ConnectionManager service, including detailed information about the format of the strings returned by GetProtocolInfo, 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 |