OEM User's Guide

OEM External Specification
OEM User’s Guide—520330-001
A-51
Adapter Request API (OEM to Adapter)
SetIcons
Use SetIcons to inform the adapter that the user has changed the default icon set within a
framework, the OEM, or a client application. The adapter can then update its own icon
set to utilize the new images if applicable.
Parameters
IconDirectoryName (input)
is the name of the directory containing the object and state images to use.
Return Value
•
0 if the adapter has accepted the call and handled the request (even if the icon set is
not updated)
•
Non-zero if the adapter cannot or will not process the request
Considerations
The adapter determines whether or not it will honor the SetIcons request and update its
icon set accordingly. In some cases, you might want to allow users to specify different
icons sets within different components of the OEM infrastructure; in these cases, the
adapter can simply ignore the SetIcons request.
An adapter that calls the OEM’s SetIcons callback method receives a SetIcons call from
the OEM; the directory name passed is identical to that supplied on the initial call.
Example
Dim Adapter As New EMAdapterClass
Dim RC As Integer
RC = Adapter.SetIcons 'C:\MyIcons'
In this example, the OEM sets the icon directory to “C:\MyIcons.”
Function SetIcons(IconDirectoryName As String) As Integer