IWMSAuthenticationPlugin::GetProtocolName
Previous | Next |
IWMSAuthenticationPlugin::GetProtocolName
The GetProtocolName method retrieves the name of the authentication type implemented by the plug-in.
Syntax
HRESULT GetProtocolName( BSTR* pProtocolName );
Parameters
pProtocolName
[out] Pointer to the BSTR containing the name.
Return Values
If the method succeeds, the plug-in must return S_OK. To report an error, the plug-in can return any HRESULT other than S_OK. If the plug-in uses the IWMSEventLog interface to log error information directly to the Windows Event Viewer, it is recommended that it return NS_E_PLUGIN_ERROR_REPORTED. Typically, the server attempts to make plug-in error information available to the server object model, the Windows Event Viewer, and the troubleshooting list in the details pane of the Windows Media Services MMC. However, if the plug-in uses the IWMSEventLog interface to send custom error information to the Windows Event Viewer, returning NS_E_PLUGIN_ERROR_REPORTED stops the server from also logging to the event viewer. For more information about retrieving plug-in error information, see Identifying Plug-in Errors.
Remarks
Anonymous, Kerberos, Digest, and NTLM are common authentication types.
Example Code
STDMETHODIMP CAuthenticatePlugin::GetProtocolName( BSTR *bstrProtocolName ) { *bstrProtocolName = SysAllocString( L"ProtocolName" ); return S_OK; }
Requirements
Header: authen.h.
Library: WMSServerTypeLib.dll.
Platform: Windows Server 2003, Enterprise Edition; Windows Server 2003, Datacenter Edition; Windows Server 2008.
See Also
Previous | Next |