Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Represented by 'Returns' in the function format, this is the value that the function returns when it is called.
Valid values include:

VOID

No value is returned

  
When a void or no value is returned, you might use the function in the following manner:

No value is returned

LceFunction(parameter1, parameter2)

or

CALL LceFunction(parameter1, parameter2)

BOOL

A boolean value is returned.

TRUE is 1

FALSE is 0. False normally results in an error code. A list of the error codes is in Appendix A of this guide.

...

 BOOL       fOK;
fOK = LceFunction(parameter1, parameter2);
if (fOK)

}; 

 |
  
or

If LceFunction(parameter1, parameter2)

 IF LceFunction(parameter1, parameter2)  
  / comment /
ELSE
  / comment /
ENDIF

 

 |
  
or

in Visual Basic

 If LceFunction(parameter1, parameter2) = LceTrue then    ' comment  
Else
  'comment 
End If
 
'LceTrue is a constant declared with the value 1, don't confuse  it with 
'
VB True = 
VB True = -1
 

 |
 

int

An integer number is returned.

Long

A long integer is returned.

  
When an integer or long integer is returned, you might use the function in the following manner:

 int        iVal; 
iVal 
iVal =
 LceFunction
 LceFunction(parameter1,
 parameter2)
 

...

 parameter2)

Notes

This section provides important notes regarding the use of the function.
 

Portability Considerations

This section will also note any differences that may be encountered between using IBM is and other platforms as the hosts. A general discussion regarding host platform differences may be found in Things That May Be Different in the LANSA Application Design Guide's chapter: Generated Code C and SQL/ODBC Considerations.

...

Tip

Tips:

If there is a more efficient way of using the LANSA Open function, it will be described in the Tips section.

For the latest LANSA Open tips and program samples, check out LANSA's web site at {+}http://www.lansa.com/support

...

.


Related Functions

This section lists any other related functions or important areas of this guide that you should review.