IWMSPlugin::put_Enabled
.gif)
| Previous | Next |
IWMSPlugin::put_Enabled
The put_Enabled method specifies a Boolean value indicating whether the plug-in is enabled.
Syntax
HRESULT put_Enabled( VARIANT_BOOL newVal );
Parameters
newVal
[in] VARIANT_BOOL indicating whether the plug-in is enabled.
Return Values
If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.
| Return code | Number | Description |
| ERROR_LOGON_FAILURE | 0x0000052E | This can be returned by the WMS Anonymous User Authentication plug-in to indicate that the user name or password set through its custom administration interface does not match the settings for the Windows user account that is used for anonymous guests. |
| NS_E_INVALID_PLUGIN_LOAD_TYPE_CONFIGURATION | 0xC00D1454L | The plug-in does not support loading as either an in-process or an out-of-process component. |
| NS_E_NO_SCRIPT_ENGINE | 0xC00D157CL | This can be returned by the WMS Active Script Event Handler plug-in to indicate that it was unable to find a script engine to run the script indicated by its FileName property. |
| NS_E_PUBLISHING_POINT_INVALID_REQUEST_WHILE_STARTED | 0xC00D1457L | The plug-in cannot be enabled or disabled while the publishing point is running. |
| NS_E_TOO_MANY_MULTICAST_SINKS | 0xC00D1456L | Only one multicast data writer plug-in can be enabled on a publishing point. |
Remarks
When you call the get_Enabled method, the server will load the plug-in if it is not already loaded. Because the Enabled property is persistent, it may not reflect the current status of the plug-in if the status changes after get_Enabled is called. Use the IWMSPlugin::get_Status method to retrieve the plug-in status.
Example Code
#include <windows.h>
#include <atlbase.h> // Includes CComVariant.
#include "wmsserver.h"
// Declare variables and interfaces.
IWMSServer *pServer;
IWMSPlugins *pPlugins;
IWMSPlugin *pPlugin;
HRESULT hr;
CComVariant varIndex;
long lCount;
// Initialize the COM library and retrieve a pointer
// to an IWMSServer interface.
hr = CoInitialize(NULL);
hr = CoCreateInstance(CLSID_WMSServer,
NULL,
CLSCTX_ALL,
IID_IWMSServer,
(void **)&pServer);
if (FAILED(hr)) goto EXIT;
// Retrieve a pointer to an IWMSPlugins interface
// and retrieve the total count of plug-ins.
hr = pServer->get_UnicastDataSinks(&pPlugins);
if (FAILED(hr)) goto EXIT;
hr = pPlugins->get_Count(&lCount);
if (FAILED(hr)) goto EXIT;
for (long x = 0; x < lCount; x++)
{
varIndex = x;
hr = pPlugins->get_Item(varIndex, &pPlugin);
if (FAILED(hr)) goto EXIT;
// Set a Boolean value indicating that
// the plug-in is enabled.
hr = pPlugin->put_Enabled(VARIANT_TRUE);
if (FAILED(hr)) goto EXIT;
// Release temporary COM objects.
pPlugin->Release();
}
EXIT:
// TODO: Release temporary COM objects and uninitialize COM.
Requirements
Header: wmsserver.h.
Library: WMSServerTypeLib.dll.
Platform: Windows Server 2003 family, Windows Server 2008 family.
See Also
| Previous | Next |