Attributes of a call object handle

The following table lists the attributes of the call object handle.

Table 1. Attributes of a call object handle
Attribute Type Description
ASYNCHRONOUS attribute LOGICAL Applies only when the logic to be dynamically invoked resides on a Progress AppServer™.Indicates if you want the logic to run asynchronously.
ASYNC-REQUEST-HANDLE attribute HANDLE Applies only when ASYNCHRONOUS is TRUE.

A handle to an asynchronous-request object containing detailed information on your asynchronous request.

Set by the INVOKE( ) method when ASYNCHRONOUS is TRUE.
CALL-NAME attribute CHARACTER The name of one of the following:
  • A procedure or user-defined function you want to invoke dynamically
  • An attribute you want to get or set dynamically
  • A method you want to invoke dynamically
CALL-TYPE attribute INTEGER Indicates if you are dynamically:
  • Invoking a procedure
  • Invoking a user-defined function
  • Invoking a Windows DLL or UNIX shared library routine
  • Getting an attribute or invoking a method
  • Setting an attribute
EVENT-PROCEDURE attribute CHARACTER Applies only when ASYNCHRONOUS is TRUE.

The name of an internal procedure you want executed when a dynamic, asynchronous invoke completes.

Note: You must set EVENT-PROCEDURE before you execute INVOKE( ).
EVENT-PROCEDURE-CONTEXT attribute HANDLE Applies only when ASYNCHRONOUS is TRUE.

A handle to a running persistent procedure containing an internal procedure you want executed when a dynamic, asynchronous invoke completes.
HANDLE attribute HANDLE A handle to the object.
IN-HANDLE attribute HANDLE Contains one of the following:
  • A handle to a persistent, single-run, or singleton procedure
  • A handle to an object, such as a buffer or socket, whose attributes or methods you want to invoke dynamically
INSTANTIATING-PROCEDURE attribute HANDLE Returns the handle to the procedure in which an object was instantiated.
IS-PARAMETER-SET attribute LOGICAL Indicates if you have already set a particular parameter.
LIBRARY attribute CHARACTER Specifies the name of a Windows DLL or a UNIX shared library.
LIBRARY-CALLING-CONVENTION attribute CHARACTER Specifies the calling convention for a Windows DLL or a UNIX shared library.
NUM-PARAMETERS attribute INTEGER The number of parameters you are passing.
ORDINAL attribute INTEGER Specifies the number of the entry point of the Windows DLL routine to invoke.
PERSISTENT attribute LOGICAL Indicates if you want an external procedure you plan to invoke dynamically to run as persistent.1
PROCEDURE-TYPE attribute CHARACTER Indicates if you want an external procedure you plan to invoke dynamically to run as persistent, single-run, or singleton. Takes values of "PERSISTENT", "SINGLE-RUN", or "SINGLETON", respectively.1
RETURN-VALUE attribute RETURN-VALUE-

DATA-TYPE

 Applies only to user-defined functions, attributes, and methods.Contains one of the following:
  • The value returned by a user-defined function
  • The value of an attribute
  • The value returned by a method
RETURN-VALUE-DATA-TYPE attribute CHARACTER The data type of the return value.

Applies only to user-defined functions, attributes, and methods.

If you set this before you execute the INVOKE( ) method, the return value is converted to this data type.

If you do not set this before you execute the INVOKE( ) method, it indicates the return value's data type.
RETURN-VALUE-DLL-TYPE attribute CHARACTER Specifies the expected data type returned from a Windows DLL routine.
SERVER attribute HANDLE A handle to an AppServer containing logic you want to invoke dynamically.
TYPE attribute CHARACTER The type of a handle.
1 See Run an internal procedure of a persistent external procedure for details on how the PERSISTENT and PROCEDURE-TYPE attributes interact.