IWMSFileDescriptions::Delete

banner art

Previous Next

IWMSFileDescriptions::Delete

The Delete method removes an IWMSFileDescription interface from the IWMSFileDescriptions collection.

Syntax

  HRESULT Delete(
  const  VARIANT  varIndex
);

Parameters

varIndex

[in] VARIANT containing the IWMSFileDescription interface to be removed.

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;
IWMSFileDescriptions    *pFileDescriptions;

HRESULT         hr;
CComVariant     varIndex;
CComBSTR        bstrPath;
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 IWMSFileDescriptions interface
// and retrieve the total count of descriptions.
bstrPath = "file://c:\\wmpub\\wmroot";
hr = pServer->get_FileDescriptions(bstrPath,
                                   WMS_FILE_UNSPECIFIED,
                                   &pFileDescriptions);
if (FAILED(hr)) goto EXIT;
hr = pFileDescriptions->get_Count(&lCount);
if (FAILED(hr)) goto EXIT;

// Delete the first file description from the collection.
varIndex = 0;
hr = pFileDescriptions->Delete(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
  • Last updated on