PLMValidationInterfaces Interface CATIREVSlide
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIREVSlide
Interface to manage a Slide.
Errors not documented on each method:
- E_OUTOFMEMORY
- One memory allocation fails.
- E_UNEXPECTED
- There is an unexpected failure.
Method Index
- o
Duplicate(CATIREVSlide*)
- Copies information from a given Slide.
- o
GetThumbnail(CATPixelImage*&)
- Retrievces the image of the associated Thumbnail.
- o
UpdateThumbnail()
- Updates the thumbnail associated to the slide.
Methods
o Duplicate
| public virtual Duplicate( | | ipiSlide) |
-
Copies information from a given Slide.
- Parameters:
-
- ipiSlide
- The Slide to copy.
Legal values:
- Valid
- The Slide is valid.
- Not valid
- The Slide is not valid.
- Returns:
- HRESULT
Legal values:
- S_OK
- The Slide is succesfully copied.
- E_INVALIDARG
- The given Slide is not valid.
Cases Matrix:
| this | ipiSlide | HRESULT |
| Valid | Valid | S_OK |
| Valid | Not valid | E_INVALIDARG |
o GetThumbnail
| public virtual GetThumbnail( | | opThumbnail) |
-
Retrievces the image of the associated Thumbnail.
- Parameters:
-
- opThumbnail
- The image.
Legal values:
- Valid
- The image is valid.
- NULL
- There is no image.
- Returns:
- HRESULT
Legal values:
- S_OK
- The image is succesfully returned.
- E_FAIL
- There is an error.
Cases Matrix:
| this | opThumbnail | HRESULT |
| Valid | Valid | S_OK |
| Valid | NULL | E_FAIL |
o UpdateThumbnail
| public virtual UpdateThumbnail( | ) |
-
Updates the thumbnail associated to the slide.
- Returns:
- HRESULT
Legal values:
- S_OK
- The Thumbnail is succesfully updated.
- E_FAIL
- The given Slide is not valid , the environment does not allow update or current state is consistent with Slide.
This object is included in the file: CATIREVSlide.h
If needed, your Imakefile.mk should include the module: PLMValidationItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.