CreateStreamOverRandomAccessStream function

Creates an IStream around a Windows Runtime IRandomAccessStream object.

Syntax

HRESULT CreateStreamOverRandomAccessStream(
  IUnknown *randomAccessStream,
  REFIID   riid,
  void     **ppv
);

Parameters

randomAccessStream

The source IRandomAccessStream.

riid

A reference to the IID of the interface to retrieve through ppv, typically IID_IStream. This object encapsulates randomAccessStream.

ppv

When this method returns successfully, contains the interface pointer requested in riid, typically IStream.

Return Value

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

We recommend that you use the IID_PPV_ARGS macro, defined in Objbase.h, to package the riid and ppv parameters. This macro provides the correct IID based on the interface pointed to by the value in ppv, which eliminates the possibility of a coding error in riid that could lead to unexpected results.

Requirements

   
Minimum supported client Windows 8 [desktop apps | UWP apps]
Minimum supported server Windows Server 2012 [desktop apps | UWP apps]
Target Platform Windows
Header shcore.h
Library ShCore.lib
DLL ShCore.dll

See Also

CreateRandomAccessStreamOnFile

CreateRandomAccessStreamOverStream

RandomAccessStream