OEM User's Guide

OEM External Specification
OEM User’s Guide—520330-001
A-53
OEM Callback API (Adapter to OEM)
OEM Callback API (Adapter to OEM)
The OEM Callback API defines the set of methods and properties that adapters use to
pass command information back to the OEM Server.
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
The Command method is used to return framework command information to the OEM
Server. This method is called whenever the user selects a popup menu item in the
framework, or when some other means is used to invoke a command.
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.
Caption (input)
is the caption of the selected menu item. The OEM Server uses this value to
determine which client application should receive the command.
Return Value
•
0 if the OEM Server has accepted and handled the command.
•
Non-zero if the OEM Server cannot or will not process the command
Considerations
The Caption item is originally set by the client application using the Popup.Add
method. The caption returned by the framework for that item must be identical to the
caption specified by the client.
The OEM Gateway returns 0 if it has accepted the command and non-zero if it has not.
If a non-zero value is returned, the adapter is not required to do anything. However, it
might choose to perform some sort of error processing if necessary.
Function Command(Path As String, ObjectName As String,
Caption As String) As Integer