Share via

  • Article

GetStream Method (IItem)

Topic Last Modified: 2006-06-13

Returns the item's content stream.

Applies To

IItem Interface

Type Library

Microsoft CDO for Exchange 2000 Library

DLL Implemented In

CDOEX.DLL

Syntax

Function GetStream() As ADODB.Stream
HRESULT GetStream
(
        _Stream** pVal
);

Parameters

  • pVal
    Returns a reference to the _Stream Interface of the item.

Return Value

Returns S_OK if successful, or an error value otherwise.

Remarks

The GetStream method returns a _Stream object reference on a Microsoft® ActiveX® Data Objects (ADO) Stream object containing the content stream for the item. Only items that are of a stream-based content class have associated streams. If you call GetStream on a collection-based item, an error is raised.

If you modify the content in the returned Stream object, you commit these changes by calling the _Stream::Flush method. If the Flush method is not called, changes are lost when the Stream object is destroyed.