Share via


IWMSPlugin::get_SelectionOrder

banner art

Previous Next

IWMSPlugin::get_SelectionOrder

The get_SelectionOrder method 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

  HRESULT get_SelectionOrder(
  
  long*
  
  pVal
  
  );

Parameters

pVal

[out] Pointer to a long containing the selection order.

Return Values

If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.

Return code Number Description
E_OUTOFMEMORY 0x8007000E There is insufficient memory to complete the function.
E_POINTER 0x80004003 pVal is a NULL pointer argument.

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

      // Release temporary COM objects.
    pPlugin->Release();




Requirements

Header: wmsserver.h.

Library: WMSServerTypeLib.dll.

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

See Also

Previous Next