PLMValidationInterfaces Interface CATIMarker2DFactory
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIMarker2DFactory
Interface to manage 2D Marker which belong to a Review.
Errors not documented on each method:
- E_OUTOFMEMORY
- One memory allocation fails.
- E_UNEXPECTED
- There is an unexpected failure.
Method Index
- o
CreateMarker2D(CATString,IID&,void**)
- Creates a 2D Marker.
- o
ListMarker2Ds(CATListValCATBaseUnknown_var&)
- Retrieves the list of 2D Markers which belong to a Review.
Methods
o CreateMarker2D
| public virtual CreateMarker2D( | | iMarkerType, |
| const | iIID, |
| | opiMarker) |
-
Creates a 2D Marker.
- Parameters:
-
- iMarkerType
- The type of the 2D Marker.
Legal values:
- "2DMarkerText"
- The Marker is a 2D Marker Text.
- iIID
- The IID of the interface.
- opiMarker
- [out, CATBaseUnknown#Release] The created Marker.
Legal values:
- Valid
- The Marker is valid.
- NULL
- The Marker is not created.
- Returns:
- HRESULT
Legal values:
- S_OK
- The Marker is succesfully created.
- E_FAIL
- The Review is not alive.
o ListMarker2Ds
| public virtual ListMarker2Ds( | | oMarker2DsList) |
-
Retrieves the list of 2D Markers which belong to a Review.
- Parameters:
-
- oMarker2DsList
- The list of 2D Markers.
Legal values:
- Empty
- There is no 2D Markers or there is an error.
- Filled
- There are some 2D Markers (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 alive.
This object is included in the file: CATIMarker2DFactory.h
If needed, your Imakefile.mk should include the module: PLMValidationItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.