Visit Platform at http://www.platform.com

Main Page   Compound List   Compound Members  

ISoamInputStream Interface Reference

A stream object that will be used by a Message object for reading, de-serializing. More...

List of all members.


Public Methods

HRESULT ReadString ([out, retval] VARIANT *pval)
 read a string from the input stream.

HRESULT ReadInt32 ([out, retval] VARIANT *pval)
 read an int from the input stream.

HRESULT ReadUInt32 ([out, retval] VARIANT *pval)
 read an unsigned int from the input stream.

HRESULT ReadInt64 ([out, retval] VARIANT *pval)
 read a long from the input stream.

HRESULT ReadUInt64 ([out, retval] VARIANT *pval)
 read an unsigned long from the input stream.

HRESULT ReadBoolean ([out, retval] VARIANT *pval)
 read a boolean from the input stream.

HRESULT ReadInt16 ([out, retval] VARIANT *value)
 read a short from the input stream.

HRESULT ReadUInt16 ([out, retval] VARIANT *value)
 read an unsigned short from the input stream.

HRESULT ReadFloat ([out, retval] VARIANT *value)
 read a float from the input stream.

HRESULT ReadDouble ([out, retval] VARIANT *value)
 read a double from the input stream.

HRESULT ReadByteArray ([out, retval] VARIANT *value)
 read a byte array from the input stream. The byte array will be allocated and returned in this method call. The caller becomes the owner of the memory and must delete it.


Detailed Description

A stream object that will be used by a Message object for reading, de-serializing.

Input Streams involve the fundamental operations to retrieve the following basic types of data:

See also:
ISoamMessage


Member Function Documentation

HRESULT ReadString [out, retval] VARIANT *    pval
 

read a string from the input stream.

NOTE: The developer is responsible for the management of the string returned from this read operation.

Parameters:
x  [OUT] - returns the read string.
Exceptions:
ISoamException 

HRESULT ReadInt32 [out, retval] VARIANT *    pval
 

read an int from the input stream.

Parameters:
x  [OUT] - returns the read integer.
Exceptions:
ISoamException 

HRESULT ReadUInt32 [out, retval] VARIANT *    pval
 

read an unsigned int from the input stream.

Parameters:
x  [OUT] - returns the read unsigned integer.
Exceptions:
ISoamException 

HRESULT ReadInt64 [out, retval] VARIANT *    pval
 

read a long from the input stream.

Parameters:
x  [OUT] - returns the read long.
Exceptions:
ISoamException 

HRESULT ReadUInt64 [out, retval] VARIANT *    pval
 

read an unsigned long from the input stream.

Parameters:
x  [OUT] - returns the read unsigned long.
Exceptions:
ISoamException 

HRESULT ReadBoolean [out, retval] VARIANT *    pval
 

read a boolean from the input stream.

Parameters:
x  [OUT] - returns the read bool.
Exceptions:
ISoamException 

HRESULT ReadInt16 [out, retval] VARIANT *    value
 

read a short from the input stream.

Parameters:
x  [OUT] - returns the read short.
Exceptions:
ISoamException 

HRESULT ReadUInt16 [out, retval] VARIANT *    value
 

read an unsigned short from the input stream.

Parameters:
x  [OUT] - returns the read unsigned short.
Exceptions:
ISoamException 

HRESULT ReadFloat [out, retval] VARIANT *    value
 

read a float from the input stream.

Parameters:
x  [OUT] - returns the read float.
Exceptions:
ISoamException 

HRESULT ReadDouble [out, retval] VARIANT *    value
 

read a double from the input stream.

Parameters:
x  [OUT] - returns the read double.
Exceptions:
ISoamException 

HRESULT ReadByteArray [out, retval] VARIANT *    value
 

read a byte array from the input stream. The byte array will be allocated and returned in this method call. The caller becomes the owner of the memory and must delete it.

Parameters:
x  [OUT, RETVAL] - returns the read byte array.
Exceptions:
ISoamException 


     
Date Modified: 28 Apr 2011
Platform Support: support@platform.com
Platform Information Development: doc@platform.com

Platform Computing. Accelerating Intelligence(TM).
Copyright © 2001-2009 Platform Computing Corporation. All rights reserved.