PLMValidationInterfaces Interface CATIREVReview
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIREVReview
Interface to manage a Review.
Errors not documented on each method:
- E_OUTOFMEMORY
- One memory allocation fails.
- E_UNEXPECTED
- There is an unexpected failure.
Method Index
- o
CreateSlide(CATIREVSlide*&)
- Creates a Slide.
- o
ImportFile(CATUnicodeString&)
- Imports a file.
- o
ListSlides(CATListValCATBaseUnknown_var&)
- Retrieves the list of Slides which belong to the Review.
Methods
o CreateSlide
| public virtual CreateSlide( | | opiSlide) |
-
Creates a Slide.
- Parameters:
-
- opiSlide
- [out, CATBaseUnknown#Release] The created Slide.
Legal values:
- Valid
- The Slide is valid.
- NULL
- The Slide is not created.
- Returns:
- HRESULT
Legal values:
- S_OK
- The Slide is succesfully created.
- E_FAIL
- The Review is not valid.
Cases Matrix:
| this | opiSlide | HRESULT |
| Valid without Slides | Valid | S_OK |
| Valid with Slides | Valid | S_OK |
| Not Valid | NULL | E_FAIL |
o ImportFile
| public virtual ImportFile( | const | iuFilePath) |
-
Imports a file.
- Parameters:
-
- iuFilePath
- The path of the file to be imported.
Legal values:
- Valid
- The path and the file are valid.
- Not Valid
- The path or the file are not valid.
- Returns:
- HRESULT
Legal values:
- S_OK
- The file is succesfully imported
- E_INVALIDARG
- The path or the file are not valid.
- E_FAIL
- The Review is not valid.
Cases Matrix:
| this | iuFilePath | HRESULT |
| Valid | Valid | S_OK |
| Valid | Not Valid | E_INVALIDARG |
| Not Valid | Valid | E_FAIL |
o ListSlides
| public virtual ListSlides( | | oSlidesList) |
-
Retrieves the list of Slides which belong to the Review.
- Parameters:
-
- oSlidesList
- The list of Slides. Warning this list is cleaned before treatment.
Legal values:
- Empty
- There is no Slides or there is an error.
- Filled
- There are some Slides (in this case the order is not specified).
- Returns:
- HRESULT
Legal values:
- S_OK
- The list is successfully returned.
- E_FAIL
- The Review is not valid.
Cases Matrix:
| this | oSlidesList | HRESULT |
| Valid without Slides | Empty | S_OK |
| Valid with Slides | Filled | S_OK |
| Not Valid | Empty | E_FAIL |
This object is included in the file: CATIREVReview.h
If needed, your Imakefile.mk should include the module: PLMValidationItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.