SET-CALLBACK-PROCEDURE( ) method
- Last Updated: January 18, 2024
- 2 minute read
- OpenEdge
- Version 12.8
- Documentation
Associates an internal procedure with an ABL callback event.
Return type: LOGICAL
Applies to: Buffer object handle, Procedure object handle, ProDataSet object handle, Query object handle
Syntax
|
- callback-name
- A quoted string or character expression representing the name of a
callback. The callback-name is not case-sensitive.
- For a ProDataSet buffer object handle, this can be
"BEFORE-FILL","AFTER-FILL","BEFORE-ROW-FILL","AFTER-ROW-FILL","ROW-CREATE","ROW-DELETE","ROW-UPDATE","FIND-FAILED", or"SYNCHRONIZE". - For a Procedure object handle, when calling a Web service, this
can be either
"REQUEST-HEADER" or"RESPONSE-HEADER". - For a ProDataSet object handle, this can be
"BEFORE-FILL"or"AFTER-FILL". - For a Query object handle, this can be
"OFF-END".
You can also use the APPLY-CALLBACK( ) method to apply a callback procedure for an object.
- For a ProDataSet buffer object handle, this can be
- internal-procedure
- A quoted string or character expression representing the name of an internal procedure that resides within procedure-context.
- procedure-context
- A handle to a procedure that contains the internal procedure specified by internal-procedure. If not specified, THIS-PROCEDURE is used as the procedure context.
This method returns FALSE if the callback-name is not valid or if procedure-context is not a valid handle; returns TRUE otherwise. If this method is specified but cannot be invoked, or it fails, no procedure will be executed as part of the callback event.
Notes
- If this method is called multiple times, the new values passed replace the previously set values.
- To remove the callback procedure associated with a Web service procedure, invoke this
method with a valid callback-name and an empty string
(
"") for the internal-procedure. The AVM will not generate an error if an attempt is made to remove a callback procedure and a callback is not associated with the callback. - For more information on events, see the Handle-based Object Events Reference.
See also
APPLY-CALLBACK( ) method, GET-CALLBACK-PROC-CONTEXT( ) method, GET-CALLBACK-PROC-NAME( ) method, OFF-END event, ProDataSet events