Share via

IWMSPlugin::get_CustomInterface

  • Article

banner art

Previous Next

IWMSPlugin::get_CustomInterface

The get_CustomInterface method retrieves a pointer to the administration interface for the plug-in.

Syntax

  HRESULT get_CustomInterface(
  IDispatch**  ppVal
);

Parameters

ppVal

[out] Pointer to a pointer to the IDispatch interface for the administration user 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 function succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.

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

Remarks

When you call the get_CustomInterface method, the server will load the plug-in if it is not already loaded. Some plug-ins do not have user interfaces.

Example Code

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