Prototype syntax

Because the objects of the HCL® OneDB® .NET Core Provider can be used in many different programming languages, the prototypes of the methods are given in this publication using a pseudo code.

The syntax of the pseudo code is as follows:

                                           .-,-----------------------.
                                           V                         |
>>-+--------+--returntype--methodname--(----+---------------------+-+--)-><
   '-static-'                               '-parmtype--parmlabel-'

returntype: This is the type of the object that is returned. If the method returns nothing then this will be void.
methodname: The name of the method.
parmtype: What type of object is expected at this position in the argument list.
parmlabel: A name for the parameter. This is only used as a convenience when referring to the parameter in the text. This parameter name will always be italicized, even in the text.

If the static keyword is present it means that the method is callable without creating an instance of the class of which it is a part. In place of the instance of the class use the name of the class itself. In Visual Basic this is called a Shared method. In C# it is called a static method.

Example: The IfxDecimal.Floor method is static and accepts a single IfxDecimal. That means that if mydec is an instance of IfxDecimal you can call floor on it like this: IfxDecimal.Floor(mydec). But you cannot call it like this: mydec.Floor(mydec).

The syntax for prototypes of constructors is the same as the syntax shown in this topic except that static and returntype are not used.