Share via

IWMSPlugin::get_ErrorText

  • Article

banner art

Previous Next

IWMSPlugin::get_ErrorText

The get_ErrorText method retrieves the text associated with the plug-in error.

Syntax

  HRESULT get_ErrorText(
  BSTR*  pVal
);

Parameters

pVal

[out] Pointer to a BSTR containing the text associated with the plug-in error.

Return Values

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

Return code Number Description
E_OUTOFMEMORY 0x8007000E There is insufficient memory to complete the function.
E_POINTER 0x80004003 pVal is a NULL pointer argument.

Remarks

This property is valid only if the bit flag is set to the value returned by the IWMSPlugin::get_Status method. The bit flag identifies the state of the plug-in.

You can use the IWMSLoggingAdmin interface to record plug-in errors in the Windows event log. If the event log contains a WMS_EVENT_LOG_LEVEL_ERROR, the HRESULT specified in the IWMSLoggingAdmin interface is returned by the get_ErrorCode method.

When you set the Enabled property to VARIANT_FALSE, the ErrorText property is automatically reset to a zero-length string. For more information, see the IWMSPlugin::get_Enabled method.

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