All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMInterfaces Interface CATIVpmAggrAttribute

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIVpmAggrAttribute
 

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


interface CATIVpmAggrAttribute

This interface is implemented by all persistent ENOVIA objects, and provides means to read/write aggregate (multi-valuated) attribute values.


Method Index


o AddValue(CATUnicodeString&,long&,CORBAAny&)
Set a new Value at a given (existing) index, to replace the former value.
o Append(CATUnicodeString&,CORBAAny&)
Append a new Value.
o CountValues(CATUnicodeString&,long&)
Get the number of values.
o GetTypeName(CATUnicodeString&,CATUnicodeString&)
o GetValue(CATUnicodeString&,long&,CORBAAny&)
Get the indexed value.
o Prepend(CATUnicodeString&,CORBAAny&)
Prepend a new Value.
o RemoveValue(CATUnicodeString&,CORBAAny&)
Remove a Value.
o RemoveValue(CATUnicodeString&,long&)
Remove a Value using an index.

Methods


o AddValue
public virtual HRESULT AddValue( const CATUnicodeString& iAttributeName,
const long& iIndex,
CORBAAny& iValue)= 0
Set a new Value at a given (existing) index, to replace the former value.
Parameters:
iAttributeName
The name of the attribute.
iIndex
The concerned index. NB: iIndex must not be higher than the aggregate size.
iValue
The value to add.
Returns:
An HRESULT value.
Legal values:
S_OK
Operation OK
E_FAIL
An error occured during the process or the attribute does not exist
o Append
public virtual HRESULT Append( const CATUnicodeString& iAttributeName,
CORBAAny& iValue)= 0
Append a new Value.
Parameters:
iAttributeName
The name of the attribute.
iValue
The value to append.
Returns:
An HRESULT value.
Legal values:
S_OK
Operation OK
E_FAIL
An error occured during the process or the attribute does not exist
o CountValues
public virtual HRESULT CountValues( const CATUnicodeString& iAttributeName,
long& oCounter)= 0
Get the number of values.
Parameters:
iAttributeName
The name of the attribute.
oCounter
Number of values found.
Returns:
An HRESULT value.
Legal values:
S_OK
At least one value has been found
S_FALSE
No value found
E_FAIL
An error occured during the process
o GetTypeName
public virtual HRESULT GetTypeName( const CATUnicodeString& iAttributeName,
CATUnicodeString& oTypeName)= 0
Deprecated:
V5R14 Get the aggregat type name.
Parameters:
iAttributeName
The name of the attribute.
oTypeName
The aggregat type name.
Returns:
An HRESULT value.
Legal values:
S_OK
Attribute has been found
S_FALSE
Attribute is not valuated
E_FAIL
An error occured during the process or the attribute does not exist
o GetValue
public virtual HRESULT GetValue( const CATUnicodeString& iAttributeName,
const long& iIndex,
CORBAAny& oValue)= 0
Get the indexed value.
Parameters:
iAttributeName
The name of the attribute.
iIndex
Index.
oValue
The value found.
Returns:
An HRESULT value.
Legal values:
S_OK
Attribute is valuated
S_FALSE
Attribute is not valuated
E_FAIL
An error occured during the process or the attribute does not exist
o Prepend
public virtual HRESULT Prepend( const CATUnicodeString& iAttributeName,
CORBAAny& iValue)= 0
Prepend a new Value.
Parameters:
iAttributeName
The name of the attribute.
iValue
The value to prepend.
Returns:
An HRESULT value.
Legal values:
S_OK
Operation OK
E_FAIL
An error occured during the process or the attribute does not exist
o RemoveValue
public virtual HRESULT RemoveValue( const CATUnicodeString& iAttributeName,
CORBAAny& iValue)= 0
Remove a Value.
Parameters:
iAttributeName
The name of the attribute.
iValue
The given value.
Returns:
An HRESULT value.
Legal values:
S_OK
Operation OK
E_FAIL
An error occured during the process or the attribute does not exist
o RemoveValue
public virtual HRESULT RemoveValue( const CATUnicodeString& iAttributeName,
const long& iIndex)= 0
Remove a Value using an index.
Parameters:
iAttributeName
The name of the attribute.
iIndex
The concerned index.
Returns:
An HRESULT value.
Legal values:
S_OK
Operation OK
E_FAIL
An error occured during the process or the attribute does not exist

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

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