HP Operations Manager for Windows

 

IOvOWMsiServer Interface Reference
[MSI Server Interfaces]

The HPOM for Windows MSI server interface. More...

import "OvOWMsiClient.idl";

List of all members.


Public Member Functions
HRESULT  connectClient ([in] BSTR appName,[in] IOvOWMsiClient *client,[in] int readWriteMode,[out] IOvOWMsiServer **server,[out] int *interfaceId)
  Performs the initial connection to the MSI server.
HRESULT  registerClient ([in] int interfaceId,[in] IOvOWRegisterCondition *condition,[out] int *conditionId)
  Register your MSI client to receive HPOM server messages.
HRESULT  unregisterClient ([in] int conditionId)
  Deletes the MSI client registration with the given conditionId.
HRESULT  removeAllRegistrations ([in] int interfaceId)
  Deletes all registrations that were performed with the given interfaceId.
HRESULT  insertMessage ([in] int interfaceId,[in] IOvOWServerMessage *message)
  Call this to add an HPOM server message to the HPOM for Windows message server queue.
HRESULT  disconnectClient ([in] int interfaceId)
  Call this to explicitly disconnect your MSI client from the MSI server.

Public Attributes
const int  OVOW_MSI_CLIENT_READ = 0
  Specifies read-only access to the HPOM for Windows MSI server.
const int  OVOW_MSI_CLIENT_READWRITE = 1
  Specifies unrestricted access to the HPOM for Windows MSI server.
const int  OVOW_MSI_CLIENT_WRITE = 2
  Specifies write-only access to the HPOM for Windows MSI server.

Detailed Description

The HPOM for Windows MSI server interface.

The methods of this interface allow you to interact with the HPOM for Windows MSI server.

Each method returns the following:

During the development of an MSI client, especially for the return codes E_UNEXPECTED and E_FAIL, inspection of the trace output is helpful. You will find all trace messages of the HPOM for Windows MSI subcomponent in the tracing namespace "OvOWMsi". To find out how to enable and display these trace messages, see Using Tracing in Your COM Application.
Since:
8.00

Member Function Documentation

HRESULT IOvOWMsiServer::connectClient (  [in] BSTR  appName,
[in] IOvOWMsiClient *  client,
[in] int  readWriteMode,
[out] IOvOWMsiServer **  server,
[out] int *  interfaceId
) 
 

Performs the initial connection to the MSI server.

Returns information for your MSI client for further usage.

Parameters:
appName  Unique identifier for your application:
  • Name of your application for C-API clients
  • CLSID or ProgId of your application for COM clients
client  Pointer of your COM client (THIS). May not be NULL.
readWriteMode  One of the MSI client connection modes defined in IOvOWMsiServer.
server  Pointer used to call methods on IOvOWMsiServer.
interfaceId  Interface Id of your application used for registrations.
Returns:
S_OK if successful. Otherwise, returns a more specific HRESULT error.
See also:
MSI Client Connection Modes
HRESULT IOvOWMsiServer::disconnectClient (  [in] int  interfaceId  ) 
 

Call this to explicitly disconnect your MSI client from the MSI server.

This call also removes all the registrations performed under the given interfaceId. Finally, the MSI client is released, which may cause the MSI client's process to shut down.

Parameters:
interfaceId  the identifier of your MSI client's connection.
HRESULT IOvOWMsiServer::insertMessage (  [in] int  interfaceId,
[in] IOvOWServerMessage *  message
) 
 

Call this to add an HPOM server message to the HPOM for Windows message server queue.

This can be a message your MSI client received from the HPOM for Windows server, or it can be a new message. This call returns a failure code if your client is connected in OVOW_MSI_CLIENT_READ mode and tries to insert a changed or new HPOM server message.

Parameters:
interfaceId  the identifier of your MSI client's connection.
message  the message to be returned to the HPOM for Windows message server.
See also:
MSI Client Connection Modes
HRESULT IOvOWMsiServer::registerClient (  [in] int  interfaceId,
[in] IOvOWRegisterCondition *  condition,
[out] int *  conditionId
) 
 

Register your MSI client to receive HPOM server messages.

You need a OvOWRegisterCondition instance for this call. You can call this multiple times with different register conditions. This call returns a failure code if your client is connected in OVOW_MSI_CLIENT_WRITE mode.

Parameters:
interfaceId  identifier of your client's connection. Obtained during the call to connectClient().
condition  the register condition specifying which messages your client will receive.
conditionId  the identifier of the current registration.
See also:
IOvOWRegisterCondition.

MSI Client Connection Modes

HRESULT IOvOWMsiServer::removeAllRegistrations (  [in] int  interfaceId  ) 
 

Deletes all registrations that were performed with the given interfaceId.

Use this to quickly delete all registrations of the MSI client.

Parameters:
interfaceId  the identifier of your MSI client's connection.
HRESULT IOvOWMsiServer::unregisterClient (  [in] int  conditionId  ) 
 

Deletes the MSI client registration with the given conditionId.

Parameters:
conditionId  the identifier of the registration to be deleted.
The documentation for this interface was generated from the following file: