IWMSIPList::Remove
Previous | Next |
IWMSIPList::Remove
The Remove method removes an IWMSIPEntry object from the collection.
Syntax
HRESULT Remove( VARIANT varIndex );
Parameters
varIndex
[in] Numerical or string ordinal number specifying the location of an IWMSIPEntry object to be removed from the collection.
Return Values
If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.
Return code | Number | Description |
DISP_E_BADINDEX | 0x8002000B | The varIndex parameter does not contain a valid index. |
Example Code
#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; IWMSIPAdmin *pIPAdmin; IWMSIPList *pIPList; 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 IP Address Authorization"; 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_IWMSIPAdmin, (void **)&pIPAdmin); if (FAILED(hr)) goto EXIT; // Retrieve the list of banned IP addresses. hr = pIPAdmin->get_DisallowIP(&pIPList); if (FAILED(hr)) goto EXIT; // Remove a specific IP from the banned list. varIndex = "128.117.93.5"; hr = pIPList->Remove(varIndex); if (FAILED(hr)) goto EXIT; EXIT: // TODO: Release temporary COM objects and uninitialize COM.
Requirements
Library: WMSServerTypeLib.dll.
Platform: Windows Server 2003 family, Windows Server 2008 family.
See Also
Previous | Next |