All Frameworks Class Hierarchy This Framework Previous Indexes
ENOVDesktopDocumentBOCmds Interface ENOVIAVDADocRetrieve
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---System.CATBaseDispatch
|
+---System.CATIABase
|
+---VPMDesktopObjects.CATIAVPMVDACommand
|
+---ENOVIAVDADocRetrieve
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVIAVDADocRetrieve
Interface to retrieve document file(s) under a given document.
Role : This interface retrieves document file(s) under a given document revision or document file based on the retrieving type.
Method Index
- o
get_AllResults(CATListPtrENOVIABO*&)
- This method retrieves all the result objects.
- o
get_Result(int,ENOVIABusinessObject_var&)
- This method retrieves the object from the result list at given index.
- o
get_ResultCount(int&)
- This method retrieves the size of the result list.
- o
put_BObject(ENOVIABusinessObject_var&)
- This method sets the document revision or document file object for retrieving its document file(s).
- o
set_FormatType(CATUnicodeString&)
- This method sets the format type in the case that the retrieving type is FormatByType.
- o
set_LinkType(CATUnicodeString&)
- This method sets the link type for retrieving linked documents.
- o
set_RetrieveType(CATUnicodeString&)
- This method sets the retrieving type.
- o
set_SubMimeType(CATUnicodeString&)
- This method sets the SubMimeType in the case that the retrieving type is FormatByType.
Methods
o get_AllResults
-
This method retrieves all the result objects.
- Parameters:
-
- objList
- The list of the result objects.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_Result
public virtual HRESULT __stdcall get_Result( | int | index, |
| ENOVIABusinessObject_var& | object)=0 |
-
This method retrieves the object from the result list at given index.
- Parameters:
-
- index
- The index of the object to be retrieved in the result list .
- object
- The object at the given index of the result list.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_ResultCount
-
This method retrieves the size of the result list.
- Parameters:
-
- length
- The size of the result list.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o put_BObject
public virtual HRESULT __stdcall put_BObject( | const ENOVIABusinessObject_var& | object)=0 |
-
This method sets the document revision or document file object for retrieving its document file(s).
- Parameters:
-
- object
- The document revision.
- Returns:
- S_OK if the object is valid document revision, S_FALSE if not.
o set_FormatType
-
This method sets the format type in the case that the retrieving type is FormatByType.
- Parameters:
-
- type
- The format type
- Returns:
- S_OK.
o set_LinkType
-
This method sets the link type for retrieving linked documents.
- Parameters:
-
- type
- The link type
Legal values:
- AssociatedLink
- Request to retrieve the associatedly linked documents
- HierarchicalLink
- Request to retrieve the hierarchically linked documents
- ExternalLink
- Request to retrieve the externally linked documents
- Returns:
- S_OK.
o set_RetrieveType
-
This method sets the retrieving type.
- Parameters:
-
- type
- The retrieving type
Legal values:
- PreferredIteration
- Request to retrieve the preferred iteration (on its primary format).
- AllIterations
- Request to retrieve all the iterations (on their primary formats).
- PrimaryFormat
- Request to retrieve the primary format under current iteration (or preferred iteration if current object is document revision, which is equivalent to PreferredIteration case).
- AllFomats
- Request to retrieve all the formats under current iteration (or preferred iteration if current object is document revision).
- FormatByType
- Request to retrieve the format that matches the input format type (with or without SubMimeType), under current iteration (or preferred iteration if current object is document revision). FormatType is mandatory
- LinkedDocuments
- Request to retrieve the linked documents (LinkType is mandatory for this case)
- Returns:
- S_OK.
o set_SubMimeType
-
This method sets the SubMimeType in the case that the retrieving type is FormatByType. Default is NULL. It is used to distinguish formats when more than one format have the same format type.
- Parameters:
-
- type
- The SubMimeType
- Returns:
- S_OK.
This object is included in the file: ENOVIAVDADocRetrieve.h
If needed, your Imakefile.mk should include the module: VDD0DocBOCommands