IWMSNamedValues::Remove

banner art

Previous Next

IWMSNamedValues::Remove

The Remove method removes a name-value pair from the IWMSNamedValues collection.

Syntax

  HRESULT Remove(
  VARIANT  varIndex
);

Parameters

varIndex

[in] VARIANT containing either the name, the index number, or a pointer to the name-value pair.

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 varIndex is an invalid index location.

Example Code

#include <windows.h>
#include <atlbase.h>    // Includes CComBSTR and CComVariant.
#include "wmsserver.h"

// Declare variables and interfaces.
IWMSServer      *pServer;
IWMSNamedValues *pNamedValues;
IWMSNamedValue  *pNamedValue;

HRESULT         hr;
CComVariant     varIndex;
CComVariant     varValue;
CComBSTR        bstrName;
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 IWMSNamedValues interface
// containing descriptive information about the server.
hr = pServer->get_Properties(&pNamedValues);
if (FAILED(hr)) goto EXIT;

// Add a new property to the collection of name-value pairs.
bstrName = "System Administrator";
varValue = "Bob Jenkins";
hr = pNamedValues->Add(bstrName, varValue, &pNamedValue);
if (FAILED(hr)) goto EXIT;

// Remove the newly added property from the collection.
varIndex = "System Administrator";
hr = pNamedValues->Remove(varIndex);
if (FAILED(hr)) goto EXIT;

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