All Frameworks  Class Hierarchy  This Framework  Indexes   

CATPLMDictionary Interface VPMIDicElement

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface VPMIDicElement

This class enables to manage all basics dictionary types role: Defines the dictionary basic type


Method Index


o GetAlias(CATUnicodeString*)
Retrieves the element alias
o GetCategories(CATLISTP(IUnknown)*)
Retrieves the categories to which the elment belongs.
o GetExpositionLevel(CATUnicodeString*)
Retrieves the Element's exposition level.
o GetName(CATString*)
Retrieves the dictionary object name.
o GetUuid(CATDbBinary*)
Retrieves the dictionary object UUID.
o GetVisibility(VPMDicVISIBILITY*)
Retrieves the visibility tag og the element
o SetExpositionLevel(CATUnicodeString*)
Sets the Element's exposition level.
o Type()
Retrieves the dictionary object type.

Methods


o GetAlias
public virtual GetAlias( oAlias)
Retrieves the element alias
Parameters:
oAlias
: Alias
Returns:
S_OK, E_FAIL
o GetCategories
public virtual GetCategories( oCategories)
Retrieves the categories to which the elment belongs.
Parameters:
oCategories
: List of the categories associated with the element
Returns:
S_OK, E_FAIL
o GetExpositionLevel
public virtual GetExpositionLevel( oExpositionLevel)
Retrieves the Element's exposition level.
Parameters:
oExpositionLevel
: Exposition Level
Returns:
  • S_OK Operation succeeded.
  • E_FAIL Operation failed.
o GetName
public virtual GetName( oName)
Retrieves the dictionary object name.
Parameters:
oName
: Dictionary object name
Returns:
S_OK, E_FAIL
o GetUuid
public virtual GetUuid( oUuid)
Retrieves the dictionary object UUID.
Parameters:
oUuid
: Dictionary object UUID
Returns:
S_OK, E_FAIL
o GetVisibility
public virtual GetVisibility( oVisibility)
Retrieves the visibility tag og the element
Parameters:
oVisibility
: Visibility
Returns:
S_OK, E_FAIL
o SetExpositionLevel
public virtual SetExpositionLevel( const iExpositionLevel)
Sets the Element's exposition level.
Parameters:
iExpositionLevel
: Exposition Level
Returns:
  • S_OK Operation succeeded.
  • E_FAIL Operation failed.
o Type
public virtual Type()
Retrieves the dictionary object type.

This object is included in the file: VPMIDicElement.h
If needed, your Imakefile.mk should include the module: VPMIDicInterfaces

Copyright © 2003, Dassault Systèmes. All rights reserved.