ReturnType property

.NET Open Clients

Using the Open Client .NET OpenAPI to Directly Access the AppServer : Setting up parameters and return types : Defining the return type for a user-defined function : ReturnType property

ReturnType property

This property sets the return type of the function return value. This is the syntax:

Syntax

public int ReturnType

You must set this property to the class constant defined in Progress.Open4GL.Parameter that corresponds to the ABL data type returned by the user-defined function, as shown in the following table.

Table 32. User-defined function return types for the OpenAPI
ABL data type	Progress.Open4GL.Parameterclass constant
CHARACTER	PRO_CHARACTER
COM-HANDLE	PRO_COMHANDLE
DATE	PRO_DATE
DATETIME	PRO_DATETIME
DATETIME-TZ	PRO_DATETIMETZ
DECIMAL	PRO_DECIMAL
HANDLE	PRO_WIDGETHANDLE
INT64	PRO_INT64
INTEGER	PRO_INTEGER
LOGICAL	PRO_LOGICAL
RAW	PRO_RAW
RECID	PRO_RECID
ROWID	PRO_ROWID
WIDGET-HANDLE	PRO_WIDGETHANDLE

Note: User-defined functions returning LONGCHAR or MEMPTR cannot be run across the Open Client interfaces.

For example, to set the return type for a user-defined function to the ABL INTEGER data type, you can set the ReturnType property on a ParamArray object, parms, as follows:

parms.ReturnType = Parameter.PRO_INTEGER;