IWMSFileDescriptions::get_Item

  • Article

banner art

Previous Next

IWMSFileDescriptions::get_Item

The get_Item method retrieves an IWMSFileDescription interface from the IWMSFileDescriptions collection.

Syntax

  HRESULT get_Item(
  const VARIANT  varIndex,
  IWMSFileDescription**  pVal
);

Parameters

varIndex

[in] VARIANT containing the index of the IWMSFileDescription interface.

pVal

[out] Pointer to a pointer to the IWMSFileDescription interface. This method calls AddRef internally. To avoid memory leaks, you must call Release when you are finished using the interface.

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.
E_POINTER 0x80004003 pVal is a NULL pointer argument.

Example Code

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

// Declare variables and interfaces.
IWMSServer              *pServer;
IWMSFileDescriptions    *pFileDescriptions;
IWMSFileDescription     *pFileDescription;

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;

// Retrieve each description in the collection.
for (long x = 0; x < lCount; x++) {
    varIndex = x;
    hr = pFileDescriptions->get_Item(varIndex, &pFileDescription);
    if (FAILED(hr)) goto EXIT;

    // Release temporary COM objects.
    pFileDescription->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