CATPLMIntegrationAccess Interface CATIAdpPLMErrorReviewer

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

interface CATIAdpPLMErrorReviewer

Interface to handle a PLM Error reviewer object.

Role: This interface handles the PLM Error Reviewer object as the container for all PLM errors raised when performing PLM server Access operations.
For example :

• QEOPS operation:
• Components LifeCycle operation:

Several ErrorReviewers may exist at the same time in the current session for distinct uses.
Any application using this decides wich PLM services are to be monitored by a given ErrorReviewer
and when errors have to be scanned and read on this reviewer for reporting and/or display.

A same PLMError Reviewer can be used for while calling sequentially several PLM operations:
Eventual errors raised by each operation are added to the current set of errors contained by the Reviewer.
The set of error is only reset when deleting the Reviewer.

example:

 // Create a PLM Error Reviewer:
 CATIAdpPLMErrorReviewer* piErrorReviewer = NULL;
 HRESULT HRC = CATAdpPLMErrorReviewerFactory::CreateErrorReviewer(piErrorReviewer);
 if (SUCCEEDED(HRC) && piErrorReviewer)
 {
   // Use this PLM Error Reviewer calling service(s) that may fill it with PLMErrors
   HRC = CATAdpOpenSaveServices::Save(NULL, piErrorReviewer);
 

 
   if (FAILED(HR))
   {
 	  CATIAdpPLMErrorIterator* piErrorIterator = NULL
 	  piErrorReviewer->GetPLMErrorIterator(piErrorIterator);
 	  ...
   }
   // delete the PLM Error Reviewer after use
   piErrorReviewer->Release();
   piErrorReviewer = NULL;
 }
 
 

  
 See also: 
  
 , , 



 
Method Index
 


 
 o 
    GetPLMErrorIterator(CATIAdpPLMErrorIterator*&)
  Gets an Iterator on the set of PLM Errors stored by this ErrorReviewer.





 
Methods
 

 
 o GetPLMErrorIterator

  
  public virtual   GetPLMErrorIterator(
 
opErrorIterator)  

  

 Gets an Iterator on the set of PLM Errors stored by this ErrorReviewer.
 
Role: This method gets an Iterator to scan the list of PLM Errors stored by this ErrorReviewer.
 

  
 Parameters:
  

    

    
 opErrorIterator
   
    An iterator on the set of PLM Errors currently stored by this PLMError Reviewer.
    When the same PLMError Reviewer is used later in another service raising errors,
    get another iterator to scan the updated set of errors.
 

  
 Returns: 
  
 		 S_OK  : An error Iterator has been created from this ErrorReviewer.
 
 E_FAIL  : Error Iterator creation failed. an unexpected NULL output pointer is given.



 This object is included in the file: CATIAdpPLMErrorReviewer.h

If needed, your Imakefile.mk should include the module: CATPLMIntegrationAccess

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.