DB Link
API Reference Guide
Product Documentation:

Visualization DB Link
Documentation Home
List of all members | Public Member Functions
IldCallable Class Reference

Instances of the class IldCallable hold the description of a stored procedure or function. More...

#include <ildblink/ildcall.h>

Inheritance diagram for IldCallable:
IldSchemaEntity

Public Member Functions

virtual ~IldCallable ()
 This destructor deletes all the argument and result columns from the current object.
 
IldArgument ** getArguments () const
 Get the arguments descriptors. More...
 
IlUShort getArgumentsCount () const
 Tell the number of arguments. More...
 
IldDescriptor ** getResults () const
 Get the return value descriptors. More...
 
IlUShort getResultsCount () const
 Tell the number of return values. More...
 
IlBoolean isProcedure () const
 Tell if the object describe a procedure. More...
 
- Public Member Functions inherited from IldSchemaEntity
virtual ~IldSchemaEntity ()
 This virtual destructor is invoked when any instance of a subclass from IldSchemaEntity is being destroyed. More...
 
IldDbmsgetDbms () const
 Get the attached to connection object. More...
 
IldEntityType getEntityType () const
 Get the type of the entity. More...
 
IlInt getId () const
 get the identifier of the entity. More...
 
const char * getName () const
 Get the name of the entity. More...
 
const char * getOwner () const
 Get the owner of the entity. More...
 

Detailed Description

Instances of the class IldCallable hold the description of a stored procedure or function.

Library: dbkernel

As with all schema entity descriptor classes, this class is intended to be used on a read-only basis.

See also
IldArgument, IldDescriptor.

Member Function Documentation

◆ getArguments()

IldArgument ** IldCallable::getArguments ( ) const

Get the arguments descriptors.

Returns
The array of the argument descriptors.

◆ getArgumentsCount()

IlUShort IldCallable::getArgumentsCount ( ) const

Tell the number of arguments.

Returns
The number of arguments for the current object.

◆ getResults()

IldDescriptor ** IldCallable::getResults ( ) const

Get the return value descriptors.

Returns
The array of returned value descriptors.

◆ getResultsCount()

IlUShort IldCallable::getResultsCount ( ) const

Tell the number of return values.

Returns
The number of returned values.

◆ isProcedure()

IlBoolean IldCallable::isProcedure ( ) const

Tell if the object describe a procedure.

Returns
IlTrue if the object describes a procedure, or IlFalse if the object describes a function.