IStream Interface Reference

Inheritance diagram for IStream:

Collaboration diagram for IStream:

Classes
struct	tagSTATSTG

Public Types
enum	tagSTGTY { STGTY_STORAGE = 1 , STGTY_STREAM = 2 , STGTY_LOCKBYTES = 3 , STGTY_PROPERTY = 4 }
enum	tagSTREAM_SEEK { STREAM_SEEK_SET = 0 , STREAM_SEEK_CUR = 1 , STREAM_SEEK_END = 2 }
enum	tagLOCKTYPE { LOCK_WRITE = 1 , LOCK_EXCLUSIVE = 2 , LOCK_ONLYONCE = 4 }
typedef IStream *	LPSTREAM
typedef struct IStream::tagSTATSTG	STATSTG
typedef enum IStream::tagSTGTY	STGTY
typedef enum IStream::tagSTREAM_SEEK	STREAM_SEEK
typedef enum IStream::tagLOCKTYPE	LOCKTYPE
Public Types inherited from IUnknown
typedef IUnknown *	LPUNKNOWN

Public Member Functions
HRESULT	Seek ([in] LARGE_INTEGER dlibMove, [in] DWORD dwOrigin, [out] ULARGE_INTEGER *plibNewPosition)
HRESULT	RemoteSeek ([in] LARGE_INTEGER dlibMove, [in] DWORD dwOrigin, [out] ULARGE_INTEGER *plibNewPosition)
HRESULT	SetSize ([in] ULARGE_INTEGER libNewSize)
HRESULT	CopyTo ([in, unique] IStream *pstm, [in] ULARGE_INTEGER cb, [out] ULARGE_INTEGER *pcbRead, [out] ULARGE_INTEGER *pcbWritten)
HRESULT	RemoteCopyTo ([in, unique] IStream *pstm, [in] ULARGE_INTEGER cb, [out] ULARGE_INTEGER *pcbRead, [out] ULARGE_INTEGER *pcbWritten)
HRESULT	Commit ([in] DWORD grfCommitFlags)
HRESULT	Revert ()
HRESULT	LockRegion ([in] ULARGE_INTEGER libOffset, [in] ULARGE_INTEGER cb, [in] DWORD dwLockType)
HRESULT	UnlockRegion ([in] ULARGE_INTEGER libOffset, [in] ULARGE_INTEGER cb, [in] DWORD dwLockType)
HRESULT	Stat ([out] STATSTG *pstatstg, [in] DWORD grfStatFlag)
HRESULT	Clone ([out] IStream **ppstm)
Public Member Functions inherited from ISequentialStream
HRESULT	Read ([out, size_is(cb), length_is(*pcbRead)] void *pv, [in] ULONG cb, [out] ULONG *pcbRead)
HRESULT	RemoteRead ([out, size_is(cb), length_is(*pcbRead)] byte *pv, [in] ULONG cb, [out] ULONG *pcbRead)
HRESULT	Write ([in, size_is(cb)] const void *pv, [in] ULONG cb, [out] ULONG *pcbWritten)
HRESULT	RemoteWrite ([in, size_is(cb)] const byte *pv, [in] ULONG cb, [out] ULONG *pcbWritten)
Public Member Functions inherited from IUnknown
HRESULT	QueryInterface ([in] REFIID riid, [out, iid_is(riid)] void **ppvObject)
ULONG	AddRef ()
ULONG	Release ()

Detailed Description

Definition at line 758 of file objidl.idl.

Member Typedef Documentation

LOCKTYPE

typedef enum IStream::tagLOCKTYPE IStream::LOCKTYPE

LPSTREAM

typedef IStream* IStream::LPSTREAM

Definition at line 760 of file objidl.idl.

STATSTG

typedef struct IStream::tagSTATSTG IStream::STATSTG

STGTY

typedef enum IStream::tagSTGTY IStream::STGTY

STREAM_SEEK

typedef enum IStream::tagSTREAM_SEEK IStream::STREAM_SEEK

Member Enumeration Documentation

tagLOCKTYPE

enum IStream::tagLOCKTYPE

Enumerator
LOCK_WRITE
LOCK_EXCLUSIVE
LOCK_ONLYONCE

Definition at line 796 of file objidl.idl.

                           {
    LOCK_WRITE      = 1,
    LOCK_EXCLUSIVE  = 2,
    LOCK_ONLYONCE   = 4
  } LOCKTYPE;

tagSTGTY

enum IStream::tagSTGTY

Enumerator
STGTY_STORAGE
STGTY_STREAM
STGTY_LOCKBYTES
STGTY_PROPERTY

Definition at line 776 of file objidl.idl.

                        {
    STGTY_STORAGE   = 1,
    STGTY_STREAM    = 2,
    STGTY_LOCKBYTES = 3,
    STGTY_PROPERTY  = 4
  } STGTY;

tagSTREAM_SEEK

enum IStream::tagSTREAM_SEEK

Enumerator
STREAM_SEEK_SET
STREAM_SEEK_CUR
STREAM_SEEK_END

Definition at line 783 of file objidl.idl.

                              {
    STREAM_SEEK_SET = 0,
    STREAM_SEEK_CUR = 1,
    STREAM_SEEK_END = 2
  } STREAM_SEEK;

Member Function Documentation

Clone()

HRESULT IStream::Clone

(

[out] IStream **

ppstm

)

Commit()

HRESULT IStream::Commit

(

[in] DWORD

grfCommitFlags

)

CopyTo()

HRESULT IStream::CopyTo	(	[in, unique] IStream *	pstm,
		[in] ULARGE_INTEGER	cb,
		[out] ULARGE_INTEGER *	pcbRead,
		[out] ULARGE_INTEGER *	pcbWritten
	)

Referenced by CDesktopUpgradePropertyBag::_NewStreamFromOld().

LockRegion()

HRESULT IStream::LockRegion	(	[in] ULARGE_INTEGER	libOffset,
		[in] ULARGE_INTEGER	cb,
		[in] DWORD	dwLockType
	)

RemoteCopyTo()

HRESULT IStream::RemoteCopyTo	(	[in, unique] IStream *	pstm,
		[in] ULARGE_INTEGER	cb,
		[out] ULARGE_INTEGER *	pcbRead,
		[out] ULARGE_INTEGER *	pcbWritten
	)

RemoteSeek()

HRESULT IStream::RemoteSeek	(	[in] LARGE_INTEGER	dlibMove,
		[in] DWORD	dwOrigin,
		[out] ULARGE_INTEGER *	plibNewPosition
	)

Revert()

HRESULT IStream::Revert

(

)

Seek()

HRESULT IStream::Seek	(	[in] LARGE_INTEGER	dlibMove,
		[in] DWORD	dwOrigin,
		[out] ULARGE_INTEGER *	plibNewPosition
	)

Referenced by CRegPropertyBag::_CopyStreamIntoBuff(), CDesktopUpgradePropertyBag::_NewStreamFromOld(), Seek(), test_FileContents1(), and test_FileContents2().

SetSize()

HRESULT IStream::SetSize

(

[in] ULARGE_INTEGER

libNewSize

)

Referenced by LoadImageFromFileHandle(), test_FileContents1(), and test_FileContents2().

Stat()

HRESULT IStream::Stat	(	[out] STATSTG *	pstatstg,
		[in] DWORD	grfStatFlag
	)

Referenced by test_FileContents1(), and test_FileContents2().

UnlockRegion()

HRESULT IStream::UnlockRegion	(	[in] ULARGE_INTEGER	libOffset,
		[in] ULARGE_INTEGER	cb,
		[in] DWORD	dwLockType
	)

---

The documentation for this interface was generated from the following file:

• sdk/include/psdk/objidl.idl