Manual page for CECIL(1)

eif_attribute - return the attribute of an Eiffel object.

SYNOPSYS

#include "eif_cecil.h"

EIFFEL_TYPE eif_attribute (EIF_REFERENCE object, char * name, EIFFEL_TYPE, int * status);

DESCRIPTION

The eif_attribute() macro returns the attribute of name name, which is of type EIFFEL_TYPE.

EIFFEL_TYPE is the type of the Eiffel attribute. It can be: EIF_INTEGER, EIF_CHARACTER, EIF_BOOLEAN, EIF_DOUBLE, EIF_REAL, or EIF_REFERENCE.

If status is NULL then no status is set. Otherwise the status of the call is put into *status. Its value is one of the following:

EIF_NO_ATTRIBUTE: No attribute was found
EIF_CECIL_OK: Attribute was found.
EIF_CECIL_ERROR: An undefined error occurred, object may not be valid.

If the visible exception is enabled, then a visible exception is raised upon failure (EIF_NO_ATTRIBUTE, EIF_CECIL_ERROR).

RETURN VALUE

Upon failure, it returns (EIFFEL_TYPE) 0, otherwise the attribute is returned.

NOTES

If the return value is an EIF_REFERENCE, you must protect it with eif_protect().
You cannot access a constant attribute, or the result of a once function with eif_attribute().

CONFORMANCE

ISE Eiffel 4.5 and later.

COMPATIBILITY

eif_attribute ( object, name, type, NULL)
is equivalent to:
eif_field ( object, name, type)
which is deprecated.