Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

CreateRandomAccessStreamOnFile function

Creates a Windows Runtime random access stream for a file.

Syntax


HRESULT STDAPI CreateRandomAccessStreamOnFile(
  _In_   PCWSTR filePath,
  _In_   DWORD accessMode,
  _In_   REFIID riid,
  _Out_  void **ppv
);

Parameters

filePath [in]

The fully qualified path of the file to encapsulate.

accessMode [in]

An AccessMode value that specifies the behavior of the RandomAccessStream that encapsulates the file.

riid [in]

A reference to the IID of the interface to retrieve through ppv, typically IID_RandomAccessStream.

ppv [out]

When this method returns successfully, contains the interface pointer requested in riid, typically the IRandomAccessStream that encapsulates the file.

Return value

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

Remarks

Use the CreateRandomAccessStreamOnFile function to create a RandomAccessStream that encapsulates a file.

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.

Windows Phone 8.1: This API is supported.

Requirements

Minimum supported client

Windows 8 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2012 [desktop apps | Windows Store apps]

Header

Shcore.h

See also

RandomAccessStream
CreateRandomAccessStreamOverStream
CreateStreamOverRandomAccessStream

 

 

Community Additions

Show:
© 2014 Microsoft