RSOAvailableAttributesArray Class Reference

Public Member Functions
unsigned int	GetCount (void)
String	GetAttribute (unsigned int attribIdx)
bool	IsAttributeInArray (String attribute)

Detailed Description

Common editor interface RSO available attributes array.

If the RSOAvailableAttributesArray instance is empty, it will return 'False' in comparison checks.

# Python:
import ComponentRef
compRef = ComponentRef.ComponentRef()
attrArray = compRef.GetAvailableAttributes()
if attrArray: # Will be False if componentref has no available attributes
  pass

Member Function Documentation

String RSOAvailableAttributesArray::GetAttribute

(

unsigned int

attribIdx

)

get an attribute from the array

Parameters

attribIdx

zero based index to desired attribute( < GetCount() )

Returns

the desired attribute from the array

Exceptions

CEIException

if index is out of rangeF

unsigned int RSOAvailableAttributesArray::GetCount

(

void

)

get the number of available attributes in the array

Returns

the number of available attributes in the array

bool RSOAvailableAttributesArray::IsAttributeInArray

(

String

attribute

)

determine if the given attribute is in the array

Parameters

attribute

desired attribute

---

The documentation for this class was generated from the following file:

• RSOAvailableAttributesArray.i