IWMSAvailableIPAddresses::get_Item

The get_Item method retrieves a specific IP address, by index, from the IWMSAvailableIPAddresses collection.

HRESULT get_Item(
  VARIANT  varIndex,
  BSTR*  ppVal
);

Arguments

varIndex	[in] VARIANT containing the index of the IP address.
ppVal	[out] Pointer to a BSTR containing the IP address.

Return Value

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	ppVal is a NULL pointer argument.

Example

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

// Declare variables and interfaces.
IWMSServer                  *pServer;
IWMSAvailableIPAddresses    *pAvlIPAddresses;

HRESULT         hr;
CComVariant     varIndex;
CComBSTR        bstrIPAddress;
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 the IWMSAvailableIPAddresses
// interface and retrieve the number of IP addresses.
hr = pServer->get_AvailableIPAddresses(&pAvlIPAddresses);
if (FAILED(hr)) goto EXIT;
hr = pAvlIPAddresses->get_Count(&lCount);
if (FAILED(hr)) goto EXIT;

// Retrieve each IP address.
for (long x = 0; x < lCount; x++)
{
    varIndex = x;
    hr = pAvlIPAddresses->get_Item(varIndex, &bstrIPAddress);
    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

Reference

IWMSAvailableIPAddresses Interface