PLMValidationInterfaces Interface CATIVALConcern
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIVALConcern
Interface to manage Concern.
Errors not documented on each method:
- E_OUTOFMEMORY
- One memory allocation fails.
- E_UNEXPECTED
- There is an unexpected failure.
Method Index
- o
GetPublished(IID&,void**)
- Retrieves the Published data of the Concern.
- o
LoadPublished()
- Loads the Published data of the Concern.
- o
SetPublished(CATBaseUnknown*)
- Sets the Published data of the Concern.
Methods
o GetPublished
| public virtual GetPublished( | const | iIID, |
| | opiInternal) |
-
Retrieves the Published data of the Concern.
- Parameters:
-
- iIID
- The IID of the interface.
- opiInternal
- [out, CATBaseUnknown#Release] The Published data.
Legal values:
- Valid
- The Published data is valid.
- NULL
- The Published data is not set or there is an error.
- Returns:
- HRESULT
Legal values:
- S_OK
- The Published data is successfully returned.
- S_FALSE
- The Published data is not set.
- E_NOINTERFACE
- The interface does not exist on the Published data.
- E_ACCESSDENIED
- The Published data is not in session.
- E_FAIL
- The Concern is not alive.
Cases Matrix:
| this | iIID | opiInternal | HRESULT |
| Alive without Published data | Valid | NULL | S_FALSE |
| Alive with unset Published data | Valid | NULL | S_FALSE |
| Alive with Published data already in session | Valid | Valid | S_OK |
| Alive with Published data already in session | Not valid | NULL | E_NOINTERFACE |
| Alive with Published data not in session | Valid | NULL | E_ACCESSDENIED |
| Not Alive | Valid | NULL | E_FAIL |
o LoadPublished
| public virtual LoadPublished( | ) |
-
Loads the Published data of the Concern.
- Returns:
- HRESULT
Legal values:
- S_OK
- The Published data is successfully loaded.
- E_FAIL
- The Concern is not alive.
Cases Matrix:
| this | HRESULT |
| Alive without Published data | E_FAIL |
| Alive with unset Published data | E_FAIL |
| Alive with Published data already in session | S_FALSE |
| Alive with Published data not in session | S_OK |
| Not Alive | E_FAIL |
o SetPublished
| public virtual SetPublished( | | ipiInternal) |
-
Sets the Published data of the Concern.
- Parameters:
-
- ipiInternal
- The Published data.
Legal values:
- Valid
- The provided linkable can be a Published data.
- NULL
- The Published data has to be unset.
- Not valid
- The provided linkable cannot be a Published data.
- Returns:
- HRESULT
Legal values:
- S_OK
- The Published data is successfully set.
- E_INVALIDARG
- The Published data is not valid.
- E_FAIL
- The Concern is not alive.
Cases Matrix:
| this | ipiInternal | HRESULT |
| Alive | Not valid | E_INVALIDARG |
| Alive without Published data | Valid | S_OK |
| Alive without Published data | NULL | S_OK |
| Alive with Published data | Valid | S_OK |
| Alive with Published data | NULL | S_OK |
| Not Alive | Valid | E_FAIL |
This object is included in the file: CATIVALConcern.h
If needed, your Imakefile.mk should include the module: PLMValidationItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.