OEM User's Guide

OEM External Specification
OEM User’s Guide—520330-001
A-13
OEM Request API (Client Application to OEM)
Object.Delete
Use Object.Delete to remove objects from the EM Framework. To remove multiple
objects as part of a single operation, block them together. Although the OEM Gateway
could require that client applications report objects at level n, the EM framework adapter
could report at a higher level. In these cases, the framework determines whether the
higher level objects should be removed from the framework. In most cases, this decision
is based on whether all subordinate objects have been removed.
Parameters
Path (input)
is the full path of all objects included in ObjectNames; for example \NewYork. If
this value is not “”, it is prefixed to each item contained in the ObjectNames list.
This simplifies building the ObjectNames list for client applications in cases
where a large number of objects are to be deleted.
ObjectNames (input)
is a comma-separated list of all objects to be deleted. While the standard
ObjectNames format of:
ObjectName[:State[:Context]] [,ObjectName[:State[:Context]], …]
is supported, the State and Context values are ignored for delete operations.
ClientName (input)
is a client-defined name used to identify the owner of a particular object and
determine the related client callback object. 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 an object to be deleted from the OEM Gateway and EM framework, it must first
have been added using the Object.Add method.
Example
Dim OEM As New OEMClass
Dim RC As Integer
Function Object.Delete(Path As String, ObjectNames As String,
ClientName As String) As Integer