PLMSRMExposedServices Interface CATIPLMChannelReportGlobal
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIPLMChannelReportGlobal
Interface representing the global status of a PLMChannel operation.
Role: A PLM Channel is an exchange context created between two specific
repositories in order to allow optimized back and forth data exchange and ownership transfers.
Data exchanges and site ownership transfers are performed using a PLMBriefcase file.
The PLMBriefcase file contains also a report for operations performed during ,
and
. This report contains a global status of the operation to know if the operation succeeded or failed.
Method Index
- o
GetErrorKey(CATString&)
- Get the error key identifying the error in case of failure.
- o
GetOperationGlobalStatus(CATPLMChannelOperationGlobalStatus&)
- Get the global operation status of the PLMChannel operation.
- o
GetOriginalErrorMessage(CATUnicodeString&)
- Get the original error message as displayed when the operation was performed.
Enumerated Type Index
- o
CATPLMChannelOperationGlobalStatus
- Global PLMChannel operation status.
Methods
o GetErrorKey
| public virtual GetErrorKey( | | oErrorKey) |
-
Get the error key identifying the error in case of failure.
Role: This method is used to get the error key identifying the error in case of failure
during
,
and
.
- Parameters:
-
- oErrorKey
- [out] The error key of the error in case of failure.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- if the initialization of the report succeeds.
- S_FALSE
- if the original operation was not a failure.
- E_INVALIDARG
- the file is not a briefcase or does not contain any report.
- E_FAIL
- if there is any other problem.
o GetOperationGlobalStatus
| public virtual GetOperationGlobalStatus( | | oPLMChannelOperationGlobalStatus) |
-
Get the global operation status of the PLMChannel operation.
Role: This method is used to get the global operation status performed during
,
and
.
- Parameters:
-
- oPLMChannelOperationGlobalStatus
- [out] The global status of the PLMChannel operation.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- if the initialization of the report succeeds.
- E_INVALIDARG
- the file is not a briefcase or does not contain any report.
- E_FAIL
- if there is any other problem.
o GetOriginalErrorMessage
| public virtual GetOriginalErrorMessage( | | oErrorMessage) |
-
Get the original error message as displayed when the operation was performed.
Role: This method is used to get the error message as displayed when the operation was performed.
The localization is the one used when the original operation was performed.
- Parameters:
-
- oErrorMessage
- [out] The original error message.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- if the initialization of the report succeeds.
- S_FALSE
- if the original operation was not a failure
- E_FAIL
- if there is any other problem.
Enumerated Types
o CATPLMChannelOperationGlobalStatus
-
enum CATPLMChannelOperationGlobalStatus {
Failure,
Success,
Warning
}
Global PLMChannel operation status.
- Parameters:
-
- Failure
- The PLMChannel operation failed.
- Success
- The PLMChannel operation Succeeded.
This object is included in the file: CATIPLMChannelReportGlobal.h
If needed, your Imakefile.mk should include the module: PLMChannelAPI
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.