HP Operations Manager for Windows

 

IOvPmdStream2 Interface Reference

Extension of IOvPmdStream interface. More...

import "OvPmdStream.idl";

Inheritance diagram for IOvPmdStream2:

IOvPmdStream List of all members.

Public Types
enum   OVPMD_STREAM_FORMAT { OVPMDSTREAM_UNKNOWN = 0, OVPMDSTREAM_UNICODE = 1, OVPMDSTREAM_ASCII = 2, OVPMDSTREAM_UTF8 = 3 }

Public Member Functions
HRESULT  GetByteArray ([out, retval] VARIANT *pvBuffer)
HRESULT  SetByteArray ([in] VARIANT vBuffer,[in] long lLength,[out, retval] long *plWritten)
HRESULT  GetString ([in] OVPMD_STREAM_FORMAT eFormat,[out, retval] BSTR *pBstr)
HRESULT  SetString ([in] BSTR dataStr,[in] OVPMD_STREAM_FORMAT eFormat,[out, retval] long *plWritten)

Detailed Description

The interface IOvPmdStream2 inherits from the interface IOvPmdStream, and adds additional methods.
Since:
7.50

Member Enumeration Documentation

enum IOvPmdStream2::OVPMD_STREAM_FORMAT
 

This enumeration defines the format of the data string.

Since:
7.50
Enumerator:
OVPMDSTREAM_UNKNOWN  Data format is unknown or binary. No conversion is performed.
OVPMDSTREAM_UNICODE  Data format is UNICODE. No conversion is performed.
OVPMDSTREAM_ASCII  Data format is ASCII.
OVPMDSTREAM_UTF8  Data format is UTF8.

Member Function Documentation

HRESULT IOvPmdStream2::GetByteArray (  [out, retval] VARIANT *  pvBuffer  ) 
 
Semantics:
You can call this method from a script. It reads the entire stream content into a buffer in memory, which is allocated automatically.
Parameters:
pvBuffer  - Pointer to a Variant containing a byte array that represents the stream data.
Possible errors:
Since:
7.50
HRESULT IOvPmdStream2::GetString (  [in] OVPMD_STREAM_FORMAT  eFormat,
[out, retval] BSTR *  pBstr
) 
 
Semantics:
Returns the data stream as a UNICODE string. Before the string is returned, however, some conversions may take place, depending on the specified format of the data. For example, if the data is in UTF8 format, it is converted to UNICODE before the string is returned. If the data is already in UNICODE or in a binary format, you should specify OVPMDSTREAM_UNICODE as the format because no conversion takes place in this case.
Parameters:
eFormat  - Format of the stream data. The method converts it to a unicode string if necessary.
pBstr  - Stream data as a string.
Possible errors:
Cannot convert the stream to the specified format.
Since:
7.50
HRESULT IOvPmdStream2::SetByteArray (  [in] VARIANT  vBuffer,
[in] long  lLength,
[out, retval] long *  plWritten
) 
 
Semantics:
Deletes any previous stream data, and then writes an array of bytes to the stream.
Parameters:
vBuffer  - VARIANT containing the byte array.
lLength  - Length of the byte array.
plWritten  - Actual amount of bytes written to the stream.
Possible errors:
NULL pointer passed
Since:
7.50
HRESULT IOvPmdStream2::SetString (  [in] BSTR  dataStr,
[in] OVPMD_STREAM_FORMAT  eFormat,
[out, retval] long *  plWritten
) 
 
Semantics:
Deletes any previous stream data, converts the specified string to the specified format (if necessary), and then writes the string to the stream. For example, if you specify OVPMDSTREAM_UTF8 as the format, the UNICODE string is converted to UTF8 before the data is written to the stream. Use OVPMDSTREAM_UNICODE as the format if no conversion should be performed.
Parameters:
dataStr  - Data string to be written to the stream.
eFormat  - Specifies the format in which the string is converted before it is written to the data stream.
plWritten  - Number of characters written to the stream.
Possible errors:
Cannot convert the string
Since:
7.50