IWMSServer::get_Properties

  • Article

banner art

Previous Next

IWMSServer::get_Properties

The get_Properties method retrieves an IWMSNamedValues interface containing a collection of name-value pairs that contain descriptive information about the server.

Syntax

  HRESULT get_Properties(
  IWMSNamedValues**  pVal
);

Parameters

pVal

[out] Pointer to a pointer to an IWMSNamedValues interface.

Return Values

If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.

Return code Number Description
E_POINTER 0x80004003 Indicates that pVal is a NULL pointer argument.

Remarks

This method calls AddRef internally. To avoid memory leaks, you must call Release when you are finished using the interface.

The IWMSNamedValues interface contains a collection of **IWMSNamedValue **interfaces. You can use IWMSNamedValue objects to specify name-value pairs.

Example Code

#include <windows.h>
#include "wmsserver.h"

// Declare variables and interfaces.
IWMSServer      *pServer;
IWMSNamedValues *pProperties;

HRESULT         hr;

// 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 server properties.
hr = pServer->get_Properties(&pProperties);
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