IWMSAuthenticationContext.GetLogicalUserID (Visual Basic .NET)

  • Article

banner art

Previous Next

IWMSAuthenticationContext.GetLogicalUserID (Visual Basic .NET)

The GetLogicalUserID method obtains the logical user ID if authentication succeeds.

Syntax

Parameters

This method takes no parameters.

Return Values

This method returns a String containing the user ID. To report an error, the plug-in can throw a COMException object to the server. If the plug-in uses the IWMSEventLog object to log error information, it is recommended that it throw NS_E_PLUGIN_ERROR_REPORTED (0xC00D157D). 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 object to send custom error information to the Windows Event Viewer, throwing NS_E_PLUGIN_ERROR_REPORTED stops the server from also logging to the event viewer. For more information about plug-in error information, see Identifying Plug-in Errors.

Remarks

In many applications, the logical user ID and the impersonation account name will be the same. However, they can be different. For example, assume that user names and credentials are stored in a SQL Server database that is associated with an NT-based account. You can assign a user name to the LogicalUserID property and the name of the account to the ImpersonationAccountName property. You can use the impersonation account name to perform the access control list (ACL) check, and the logical user ID can be used to determine what access permissions the user has.

Example Code

Public Function GetLogicalUserID() As String _
    Implements IWMSAuthenticationContext.GetLogicalUserID

    Return GetImpersonationAccountName()
End Function

Requirements

Reference: Add a reference to Microsoft.WindowsMediaServices.

Namespace: Microsoft.WindowsMediaServices.Interop.

Assembly: Microsoft.WindowsMediaServices.dll.

Library: WMSServerTypeLib.dll.

Platform: Windows Server 2003, Enterprise Edition; Windows Server 2003, Datacenter Edition; Windows Server 2008.

See Also

Previous Next