Instruction Manual

OEM External Specification
OEM User’s Guide—520330-001
A-25
Client Callback API (OEM to Client Application)
ClientMessage
Use the ClientMessage method to pass framework-specific requests or commands to a
client application. This allows a client to include custom features for a specific
framework or a framework to include custom features for a specific client. In either case,
the OEM Gateway acts as a simple router and pass-through server; any data sent from
the framework is passed unaltered to the specified client.
Parameters
ClientName (input)
is the name of the client to receive the message.
Path (input)
is the full path of the selected object. For example, if the selected object is
\NewYork\DISK\$SYSTEM, Path is \NewYork\DISK. This value can be “” if the
message does not relate to a specific object.
ObjectName (input)
is the name of the selected object. For example, if the selected object is
\NewYork\DISK\$SYSTEM, ObjectName is $SYSTEM. This value can be “” if
the message does not relate to a specific object.
Message (input)
is the message to be passed to the client application.
Return Value
•
0 if the client has accepted and handled the message
•
Non-zero if the client cannot or will not process the message
Considerations
The OEM Gateway determines the callback object for the message based on the given
ClientName; therefore, the client application must previously have made itself known
to the OEM Gateway by specifying ClientName in a Popup.Add or Object.Add call.
The OEM Gateway only evaluates the return value 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 ClientMessage(ClientName As String, Path As String,
ObjectName As String, Message As String) As Integer