All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ObjectModelerBase Interface CATIReporterInfo

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIReporterInfo
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIReporterInfo

Interface to retrieve the data of an error information.

An error information is an object created via the interface CATIReporter. It is stacked in an internal list. Its data are a name and an error instance.
See CATIReporter.


Method Index


o GetAssociatedString(CATUnicodeString&)
Sets the given string to the string contained in the error information.
o GetError(CATError*&)
Gets the error associated with the error information.

Methods


o GetAssociatedString
public virtual HRESULT GetAssociatedString(CATUnicodeString& oStr) = 0
Sets the given string to the string contained in the error information.
Role: This method gets the string stored in the error information. It usually represents the name of the object that has raised this error.
Parameters:
oStr
[out] The given string.
Returns:
S_OK if everything ran ok, otherwise E_FAIL.
o GetError
public virtual HRESULT GetError(CATError*& oError) = 0
Gets the error associated with the error information.
Role: This method sets the given oError to the error instance stored in the error information.
Parameters:
oError
[out] The pointer on the error associated with the error information. Must be released.
Returns:
S_OK if everything ran ok, otherwise E_FAIL.

This object is included in the file: CATIReporterInfo.h
If needed, your Imakefile.mk should include the module: CATObjectModelerBase

Copyright © 2003, Dassault Systèmes. All rights reserved.