All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMXBom Interface ENOVIAttributeDefinitions
System.IUnknown
|
+---VPMXBom.ENOVICollectionBase
|
+---ENOVIAttributeDefinitions
Usage: you can freely reimplement this interface.
interface ENOVIAttributeDefinitions
Interface representing a list of attribute definition.
Role:
All object definition should derive from this interface, this applies to
Business Objects as well as to commands.
- See also:
- ENOVIBODefinition
- See also:
- ENOVICommand
- See also:
- ENOVIAttributeDefinition
Method Index
- o
Item(CORBAAny*,ENOVIAttributeDefinition**)
- Retrieves an attribute definition by index or by name.
- o
Item(char*,ENOVIAttributeDefinition**)
- Retrieves an attribute definition by name.
- o
Item(long,ENOVIAttributeDefinition**)
- Retrieves an attribute definition by index.
- o
get_Enum(IEnumENOVIAttributeDefinition**)
- not yet implemented
- o
get_FinderInterface(ENOVIQuery**)
- Retrieves the finder interface for this type Object.
- o
get_ListOfSubTypes(CATListOfCATString**)
- Retrieves the list of subtypes of the object described by this interface.
- o
get_TypeAlias(wchar_t**)
- Retrieves the type alias of the object described by this interface.
- o
get_TypeName(char**)
- Retrieves the type name of the object described by this interface.
- o
get_Visibility(VPMDicVISIBILITY*)
- Retrieves the visibility for this type of objects.
- o
put_Visibility(VPMDicVISIBILITY)
- Sets the visibility for this object.
Methods
o Item
-
Retrieves an attribute definition by index or by name.
- Parameters:
-
- iIndex
- 1 based index of the attribute to retrieve or name of
the attribute to retrieve
Legal values:
CORBAAny with an integer typed value > 0
- a
CORBAAny with a string (tk_string or tk_unicodestring) typed value >
- oItem
- the retrieved attribute definition.
- Returns:
- An HRESULT value
Legal values:
- S_OK
- All went well
- S_FALSE
- there is no attribute by this name
- E_???
- Something went wrong
o Item
-
Retrieves an attribute definition by name.
- Parameters:
-
- iAttributeName
- name of the attribute to retrieve
- oItem
- the retrieved attribute definition.
- Returns:
- An HRESULT value
Legal values:
- S_OK
- All went well
- S_FALSE
- there is no attribute by this name
- E_???
- Something went wrong
o Item
-
Retrieves an attribute definition by index.
- Parameters:
-
- iIndex
- 1 based index of the attribute to retrieve
- oItem
- the retrieved attribute definition.
- Returns:
- An HRESULT value
Legal values:
- S_OK
- All went well
- S_FALSE
- there is no attribute definition by this name
- E_???
- Something went wrong
o get_Enum
-
not yet implemented
o get_FinderInterface
-
Retrieves the finder interface for this type Object.
- Parameters:
-
- oFinder
- the retrieved finder inteface
- Returns:
- An HRESULT value
Legal values:
- S_OK
- All went well
- S_FALSE
- there is no attribute by this name
- E_???
- Something went wrong
- See also:
- ENOVIQuery
o get_ListOfSubTypes
-
Retrieves the list of subtypes of the object described by this interface.
- Parameters:
-
- oListOfSubTypes
- the retrieved list of types
- Returns:
- An HRESULT value
o get_TypeAlias
-
Retrieves the type alias of the object described by this interface.
- Parameters:
-
- oTypeAlias
- the retrieved type alias
- Returns:
- An HRESULT value
Legal values:
- S_OK
- All went well
- E_???
- Something went wrong
o get_TypeName
-
Retrieves the type name of the object described by this interface.
- Parameters:
-
- oTypeName
- the retrieved type name
- Returns:
- An HRESULT value
Legal values:
- S_OK
- All went well
- E_???
- Something went wrong
o get_Visibility
-
Retrieves the visibility for this type of objects.
Role:
this will influence the visibility of the attribute in the user interface.
- Parameters:
-
- oVisibility
- the retrieved Visibility
- Returns:
- An HRESULT value
Legal values:
- S_OK
- All went well
- E_???
- Something went wrong
- See also:
- VPMDicVISIBILITY
o put_Visibility
-
Sets the visibility for this object.
- Parameters:
-
- iVisibility
- the new visibility
- Returns:
- An HRESULT value
Legal values:
- S_OK
- All went well
- E_???
- Something went wrong
- See also:
- get_Visibility
This object is included in the file: ENOVIAttributeDefinitions.h
If needed, your Imakefile.mk should include the module: VPMXbmItf