Search
Module:
Directory

   Desktop Functions:

   Smart Device Functions:


Show Recent Changes
Subscribe (RSS)
Misc. Pages
Comments
FAQ
Helpful Tools
Playground
Suggested Reading
Website TODO List
Support Forum
Download Visual Studio Add-In

Terms of Use
Privacy Policy
shcreatestreamonfile (shlwapi)
 
.
Summary
Takes a file name, opens the file, and returns a COM-style IStream interface that can be used to read from and write to the file.

C# Signature:

[DllImport( "shlwapi.dll", CharSet=CharSet.Unicode, ExactSpelling=true, PreserveSig=false, EntryPoint="SHCreateStreamOnFileW" )]
static extern void SHCreateStreamOnFile( string fileName, StgmConstants mode, ref System.Runtime.InteropServices.ComTypes.IStream stream );

VB Signature:

User-Defined Types:

None.

Alternative Managed API:

Do you know one? Please contribute it!

Notes:

I have only tested this using .NET 2.0. Also note that the above import will cause the API to throw a managed exception in case of failure as opposed to returning a HRESULT error code.

See StgmConstants for the flags corresponding to the mode parameter.

Tips & Tricks:

Please add some!

Sample Code:

C#

    private System.Runtime.InteropServices.ComTypes.IStream GetComStreamForFile( string fileName )
    {
        System.Runtime.InteropServices.ComTypes.IStream stream = null;
        SHCreateStreamOnFile( fileName, StgmConstants.STGM_SHARE_DENY_WRITE, ref stream );
        return stream;
    }

Documentation

Please edit this page!

Do you have...

  • helpful tips or sample code to share for using this API in managed code?
  • corrections to the existing content?
  • variations of the signature you want to share?
  • additional languages you want to include?

Select "Edit This Page" on the right hand toolbar and edit it! Or add new pages containing supporting types needed for this API (structures, delegates, and more).

 
Access PInvoke.net directly from VS:
Terms of Use
Edit This Page
Find References
Show Printable Version
Revisions