IWMSPlugin.SelectionOrder (C#)

  • Article

banner art

Previous Next

IWMSPlugin.SelectionOrder (C#)

The SelectionOrder property specifies and retrieves a zero-based value that is used by the server to determine the order in which a plug-in will be selected for use.

Syntax

  int
   = 
  Plugin
  .SelectionOrder;

  Plugin
  .SelectionOrder = int;

Property Value

int containing the selection order.

If this property fails, it throws an exception.

Number Description
0x8007000E There is insufficient memory to complete the function.

Remarks

The selection order is particularly important for authentication and cache proxy plug-ins. For cache proxy plug-ins, the selection order can be used to specify which plug-in should be used as the default plug-in to handle cache proxy requests that other plug-ins do not handle. For authentication plug-ins, the plug-in with the lowest selection order that uses an anonymous authentication scheme, such as the WMS Anonymous User Authentication plug-in, is used first. If anonymous authentication fails, the server will begin trying non-anonymous authentication plug-ins based on their selection order. For all other types of plug-ins in which more than one type of plug-in can be used to process a request, plug-ins are selected for use based on their selection-order value.

Example Code

using Microsoft.WindowsMediaServices.Interop;
using System.Runtime.InteropServices;

// Declare variables.
WMSServer          Server;
IWMSPlugins        Plugins;
IWMSPlugin         Plugin;

int               iValue;

try {
    // Create a new WMSServer object.
    Server = new WMSServerClass();

    // Retrieve the IWMSPlugins object.
    Plugins = Server.Authenticators;

    // Retrieve information about each plug-in.
    for (int i = 0; i < Plugins.Count; i++)
    {
        Plugin = Plugins[i];

        // Retrieve the selection order of this plug-in
        // compared to other plug-ins in this collection.
        iValue = Plugin.SelectionOrder;
    }

Requirements

Reference: Add a reference to Microsoft.WindowsMediaServices.

Namespace: Microsoft.WindowsMediaServices.Interop.

Assembly: Microsoft.WindowsMediaServices.dll.

Library: WMSServerTypeLib.dll.

Platform: Windows Server 2003 family, Windows Server 2008 family.

See Also

Previous Next