OEM User's Guide

OEM External Specification
OEM User’s Guide—520330-001
A-14
OEM Request API (Client Application to OEM)
RC = OEM.Object.Delete('\Chicago', 'CPU\0, CPU\1',
'MyClientName')
In this example, the Path “\Chicago” is prefixed to each object name. This causes the
objects “\Chicago\CPU\0” and “\Chicago\CPU\1” to be removed.
Object.Cleanup
Use Object.Cleanup to remove all objects for a given client name. This is particularly
useful when a client application is shutting down and all objects associated with it must
be removed from the OEM Gateway and EM framework.
Parameters
ClientName (input)
is a client-defined name used to identify the owner of the objects. For most clients
this can simply be the application name. However, more complex clients might need
to use more than one ClientName and CallbackObject to localize processing
for different types of commands (for example, one ClientName and
CallbackObject for DISK commands and another for CPU commands).
Return Value
•
0 if the request was queued successfully
•
An OEM error number if an error occurred
Considerations
For a client application to remove any objects, it must first have added them using the
Object.Add method.
If a client application is using multiple ClientNames, it should call Object.Cleanup
for each of these names when shutting down.
Example
Dim OEM As New OEMClass
Dim RC As Integer
RC = OEM.Object.Cleanup('MyClientName')
In this example, all objects associated with “MyClientName” are removed.
Function Object.Cleanup(ClientName As String) As Integer