OEM User's Guide

OEM External Specification
OEM User’s Guide—520330-001
A-23
Client Callback API (OEM to Client Application)
Client Callback API (OEM to Client Application)
The Client Callback API defines the set of methods and properties that client
applications must include in their callback class definition so the Open Enterprise
Management Gateway can pass back command information.
The examples included in the following descriptions are given using pseudo code
similar to Visual BASIC; they might not be syntactically correct for Visual BASIC or
any other environment.
Command
Use the Command method to return framework command information to the client
application. This method is called for a given callback object whenever the user selects a
popup menu item associated with that callback.
Parameters
Path (input)
is the full path of the selected object. For example, if the selected object is
\NewYork\DISK\$SYSTEM, Path is \NewYork\DISK.
ObjectName (input)
is the name of the selected object. For example, if the selected object is
\NewYork\DISK\$SYSTEM, ObjectName is $SYSTEM.
CallbackCommand (input)
is the command corresponding to the menu item chosen by the user.
Return Value
•
0 if the client has accepted and handled the command
•
Non-zero if the client cannot or will not process the command
Considerations
The value of CallbackCommand is set by the client application using the Popup.Add
method. Whatever text was specified in the CallbackCommand parameter when the
popup was added is returned, unaltered, to the client application when the user selects
the menu item.
The OEM Gateway evaluates the return value only as zero or non-zero. A zero return
value from the call indicates that the client has accepted the command, and a non-zero
value indicates the client cannot or will not process the command. It is important that
client applications return the appropriate value, because the OEM Gateway could behave
differently based on the outcome of the call.
Function Command(Path As String, ObjectName As String,
CallbackCommand As String) As Integer