Share via

IWMSAuthenticationPlugin::GetFlags

  • Article

banner art

Previous Next

IWMSAuthenticationPlugin::GetFlags

The GetFlags method retrieves any flags that identify the challenge and response mechanism used by the plug-in.

Syntax

  HRESULT GetFlags(
  long*  pFlags
);

Parameters

pFlags

[out] Pointer to a long containing a member of the WMS_AUTHENTICATION_FLAGS enumeration type. This must be one of the following values.

Value Description
WMS_AUTHENTICATION_TEXT_CHALLENGE The challenge and response BLOB contains only text.
WMS_AUTHENTICATION_CLIENT_SHOWS_UI The client prompts the user for credentials.
WMS_AUTHENTICATION_ANONYMOUS Anonymous authentication does not retrieve credentials from the client.
WMS_AUTHENTICATION_CHALLENGE_FIRST The server initiates the authentication process and generates the challenge BLOB first.

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.

Example Code

STDMETHODIMP CAuthentPlugin::GetFlags(LONG * Flags)
{
    *Flags = WMS_AUTHENTICATION_ANONYMOUS;
    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