IWMSAdminRealm.Realm (Visual Basic .NET)

banner art

Previous Next

IWMSAdminRealm.Realm (Visual Basic .NET)

The Realm property specifies and retrieves the name of the realm that is presented to a client when prompted for a user name and password. The realm string is used to distinguish one site from another.

Syntax

  AdminRealm
  .Realm = String
String = AdminRealm.Realm

Property Value

A String containing the authentication realm. This must not exceed 251 characters.

If this property fails, it throws an exception.

Number Description
0x80070057 The string containing the realm exceeds 251 characters.

Example Code

Imports Microsoft.WindowsMediaServices.Interop
Imports System.Runtime.InteropServices

Private Sub SetRealm()

    ' Declare variables.
    Dim Server As WMSServer
    Dim Plugin As IWMSPlugin
    Dim AdminRealm As IWMSAdminRealm

Try
    ' Create the WMSServer object.
    Server = New WMSServer()

    ' Retrieve the plug-in to be configured.
    Plugin = Server.Authenticators.Item("WMS Digest Authentication")

    ' Retrieve the custom interface of the plug-in.
    AdminRealm = Plugin.CustomInterface

    ' Set the name presented to a client
    ' upon user name and password requests.
    AdminRealm.Realm = "MyRealm"

Catch excCom As COMException
    ' TODO: Handle COM exceptions.
Catch exc As Exception
    ' TODO: Handle errors.
Finally
    ' TODO: Clean-up code goes here.
End Try

End Sub

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