getAttribute()

Retrieves an attribute descriptor for an attribute of a business object, given the attribute's name or its position in the business object definition's attribute list.

Syntax

BOAttrType *getAttribute(char * name);
 BOAttrType *getAttribute(int pos);
 

Parameters

name [in]
is the attribute name.

pos [in]
is an integer that specifies the ordinal position of the attribute in the business object's attribute list.

Return values

A pointer to an instance of the BOAttrType class. These methods return NULL if an invalid attribute name or position is specified.

Notes

The getAttribute() method returns an attribute descriptor, which is an instance of the BOAttrType class, for an attribute in the business object description (BusObjSpec instance). The BOAttrType class provides methods to obtain information about the attribute properties, such as its application-specific information, default value, and whether it is required.

See also

For the methods of the BOAttrType class, see BOAttrType class

Copyright IBM Corp. 1997, 2003