All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMInterfaces Interface ENOVIExpandable
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---ENOVIExpandable
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVIExpandable
Interface that defines and manages the Expandable (Tree).
Role: Provides different modes to expand Enovia objects (PRC, Item Instance, ...).
Method Index
- o
get_Tree(long,CATLISTV(CATBaseUnknown_var)&,CATListOfInt*,CATICfgFilter_var&,CATUnicodeString&)
- Retrieves the objects from the Tree that matches the criteria of specified DocumentType, Config Filter and Domain Name.
Enumerated Type Index
- o
ExpandDocMode
-
Methods
o get_Tree
-
Retrieves the objects from the Tree that matches the criteria of specified DocumentType, Config Filter and Domain Name.
- Parameters:
-
- iLevelOrMode
- The Level or Mode.
Legal Values: The legal values for this are as follows;
- PS_ALL : returns all children matching with the filter
- PS_ROOT : returns all direct children matching with the filter
- n>=1 : expands n levels
- n<=-1 : expands n levels with DMU mode
- n=0 : expands ALL levels
- PS_DMU_CFG: returns all children matching with the filter (and their parents) if all their parents are valid for the configuration filter
- PS_DMU_CFG_1: computes all children matching with the filter (and their parents) if all their parents are valid for the configuration filter. From this list, returns only the first-level children.
- PS_DMU_CFG_2: computes all children matching with the filter (and their parents) if all their parents are valid for the configuration filter. From this list, returns only the first-level and the second-level children.
- oList
- The List of Objects in the Tree.
- oListLevel
- The List of Level.
Legal Values: The default value for oListLevel is set to NULL.
- icfgFilter
- The Config Filter.
Legal Values: The default value for the CATICfgFilter is set to NULL.
- iType
- The Type of returned object.
Legal Values: The default value for iType is set to "VPMItemInstance".
Enumerated Types
o ExpandDocMode
-
enum ExpandDocMode {
NoDocuments,
OnInst_Documentations,
OnInst_Representations,
OnInst_Documents,
OnRef_Documentations,
OnRef_Representations,
OnRef_Documents,
OnInstAndRef_Documentations,
OnInstAndRef_Representations,
OnInstAndRef_Documents
}
This object is included in the file: ENOVIExpandable.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces