Export (0) Print
Expand All
0 out of 3 rated this helpful - Rate this topic

SHCreateStreamOnFileEx function

Opens or creates a file and retrieves a stream to read or write to that file.

Syntax


HRESULT SHCreateStreamOnFileEx(
  _In_        LPCWSTR pszFile,
  _In_        DWORD grfMode,
  _In_        DWORD dwAttributes,
  _In_        BOOL fCreate,
  _Reserved_  IStream *pstmTemplate,
  _Out_       IStream **ppstm
);

Parameters

pszFile [in]

Type: LPCWSTR

A pointer to a null-terminated string that specifies the file name.

grfMode [in]

Type: DWORD

One or more STGM values that are used to specify the file access mode and how the object that exposes the stream is created and deleted.

dwAttributes [in]

Type: DWORD

One or more flag values that specify file attributes in the case that a new file is created. For a complete list of possible values, see the dwFlagsAndAttributes parameter of the CreateFile function.

fCreate [in]

Type: BOOL

A BOOL value that helps specify, in conjunction with grfMode, how existing files should be treated when creating the stream. See Remarks for details.

pstmTemplate [in, optional]

Type: IStream*

Reserved.

ppstm [out]

Type: IStream**

Receives an IStream interface pointer for the stream associated with the file.

Return value

Type: HRESULT

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

Remarks

The SHCreateStreamOnFileEx function extends the semantics of the STGM flags and produces the same effect as calling the CreateFile function.

The grfMode and fCreate parameters work together to specify how the function should behave with respect to existing files.

grfModefCreateFile exists?Behavior
STGM_CREATEIgnoredYesThe file is recreated.
STGM_CREATEIgnoredNoThe file is created.
STGM_FAILIFTHEREFALSEYesThe file is opened.
STGM_FAILIFTHEREFALSENoThe call fails.
STGM_FAILIFTHERETRUEYesThe call fails.
STGM_FAILIFTHERETRUENoThe file is created.

 

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Shlwapi.h

Library

Shlwapi.lib

DLL

Shlwapi.dll (version 6.0 or later)

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.