Share via

IWMSActiveScriptAdmin Interface

  • Article

banner art

Previous Next

IWMSActiveScriptAdmin Interface

The IWMSActiveScriptAdmin interface is the administration interface for the WMS Active Script Event Handler plug-in. This plug-in enables scripting language access to the internal events sent by the server.

In addition to the methods inherited from IDispatch, the IWMSActiveScriptAdmin interface exposes the following methods.

Method Description
get_EnableDebugging Retrieves a Boolean value that indicates whether the Microsoft Script Debugger can be used to debug the script.
get_ErrorCharacterPosition Retrieves the character position of the last error that occurred in the script when loaded by the script engine.
get_ErrorLineNumber Retrieves the line number of the last error that occurred in the script when loaded by the script engine.
get_ErrorText Retrieves the text of the last error that occurred in the script when loaded by the script engine.
get_FileName Retrieves the path to the script file.
put_EnableDebugging Specifies a Boolean value that indicates whether the Microsoft Script Debugger can be used to debug the script.
put_FileName Specifies the script file to use.

Example Code

The following example illustrates how to retrieve a pointer to an IWMSActiveScriptAdmin interface.

#include <windows.h>
#include <atlbase.h>    // Includes CComVariant.

// To access system plug-in interfaces, the
// entire type library must be imported as shown.
#import "WMSServerTypeLib.dll" no_namespace named_guids \
                               raw_interfaces_only

// Declare variables and interfaces.
IWMSServer              *pServer;
IWMSPlugins             *pPlugins;
IWMSPlugin              *pPlugin;
IDispatch               *pDispatch;
IWMSActiveScriptAdmin   *pActiveScriptAdmin;

HRESULT         hr;
CComVariant     varIndex;

// 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
// containing event handler plug-ins.
hr = pServer->get_EventHandlers(&pPlugins);
if (FAILED(hr)) goto EXIT;

// Retrieve a pointer to the IWMSPlugin interface
// of the plug-in to be configured.
varIndex = "WMS Active Script Event Handler";
hr = pPlugins->get_Item(varIndex, &pPlugin);
if (FAILED(hr)) goto EXIT;

// Retrieve a pointer to the custom interface
// of the plug-in.
hr = pPlugin->get_CustomInterface(&pDispatch);
if (FAILED(hr)) goto EXIT;

// Query the specific administration interface
// for the plug-in.
hr = pDispatch->QueryInterface(IID_IWMSActiveScriptAdmin,
                              (void **)&pActiveScriptAdmin);
if (FAILED(hr)) goto EXIT;

EXIT:
    // TODO: Release temporary COM objects and uninitialize COM.

See Also

Previous Next