org.eclipse.cdt.core.dom.ast
Interface IFunction

All Superinterfaces:

IBinding

All Known Subinterfaces:

ICPPConstructor, ICPPFunction, ICPPFunctionTemplate, ICPPMethod

public interface IFunction
extends IBinding

This represents a function in the program. A function is also a scope for other bindings.

Field Summary

Fields inherited from interface org.eclipse.cdt.core.dom.ast.IBinding

EMPTY_BINDING_ARRAY

Method Summary

IScope	getFunctionScope() Get the function scope
IParameter[]	getParameters() Returns the formal parameters of the function.
IFunctionType	getType() Get the IFunctionType for this function
boolean	isAuto()
boolean	isExtern()
boolean	isInline() Returns true if the function is inline.
boolean	isRegister()
boolean	isStatic() Returns true if the function has the static storage-class specifier similarly for extern, auto, register.
boolean	takesVarArgs() Returns true if this function takes variable arguments.

Methods inherited from interface org.eclipse.cdt.core.dom.ast.IBinding

getLinkage, getName, getNameCharArray, getOwner, getScope

Method Detail

getParameters

IParameter[] getParameters()
                           throws DOMException

Returns the formal parameters of the function.

Returns:

array of IParameter

Throws:

DOMException - if this is a problem binding.

getFunctionScope

IScope getFunctionScope()
                        throws DOMException

Get the function scope

Throws:

DOMException - if this is a problem binding.

getType

IFunctionType getType()
                      throws DOMException

Get the IFunctionType for this function

Throws:

DOMException - if this is a problem binding.

isStatic

boolean isStatic()
                 throws DOMException

Returns true if the function has the static storage-class specifier similarly for extern, auto, register.

Throws:

DOMException - if this is a problem binding.

isExtern

boolean isExtern()
                 throws DOMException

Throws:

DOMException

isAuto

boolean isAuto()
               throws DOMException

Throws:

DOMException

isRegister

boolean isRegister()
                   throws DOMException

Throws:

DOMException

isInline

boolean isInline()
                 throws DOMException

Returns true if the function is inline.

Throws:

DOMException - if this is a problem binding.

takesVarArgs

boolean takesVarArgs()
                     throws DOMException

Returns true if this function takes variable arguments.

Throws:

DOMException - if this is a problem binding.