Instances of the class IldArgument describe the arguments of a stored procedure or function. More...

#include <ildblink/ildarg.h>

Inheritance diagram for IldArgument:

Public Member Functions
IlBoolean	hasDefault () const
	Indicate whether the argument has a default value and can thus be omitted in a call to the stored procedure to which it belongs. More...

IlBoolean	isInArgument () const
	Indicate whether the argument is an input argument. More...

IlBoolean	isInOutArgument () const
	Indicate whether the argument is used both on input and on output. More...

IlBoolean	isOutArgument () const
	Indicate whether the argument is an output argument. More...

Public Member Functions inherited from IldDescriptor
IldADTDescriptor *	getADTDescriptor () const
	Get the abstract data type descriptor. More...

const char *	getName () const
	Get the name of the described object. More...

short	getPrecision () const
	Get the precision of the described object. More...

short	getScale () const
	Get the scale of the described object. More...

IlUInt	getSize () const
	Get the maximum data size of the described object. More...

short	getSqlType () const
	Get the SQL type of the decribed object. More...

const char *	getSqlTypeName () const
	Get the SQL type name of the described object. More...

IldColumnType	getType () const
	Get the type of the described object. More...

IlBoolean	isNullable () const
	Indicates whether or not the column can contain values that are `NULL` in the RDBMS sense.

Detailed Description

Instances of the class IldArgument describe the arguments of a stored procedure or function.

Library: dbkernel

Since these arguments differ from a column description only by the input and output states and by the existence of a default value, the class is derived from the basic descriptor class IldDescriptor.

See also: IldCallable.

Member Function Documentation

◆ hasDefault()

IlBoolean IldArgument::hasDefault ( ) const

Indicate whether the argument has a default value and can thus be omitted in a call to the stored procedure to which it belongs.

Note: The default value is not stored in the description.

◆ isInArgument()

IlBoolean IldArgument::isInArgument ( ) const

Indicate whether the argument is an input argument.

Note: This function return value is not the opposite of the one from the function isOutArgument.

◆ isInOutArgument()

IlBoolean IldArgument::isInOutArgument ( ) const

Indicate whether the argument is used both on input and on output.

Note: Sensibly, if the argument is an in-out argument, then both functions isInArgument() and isOutArgument() will return IlTrue.

◆ isOutArgument()

IlBoolean IldArgument::isOutArgument ( ) const

Indicate whether the argument is an output argument.