SHCreateStreamOnFileEx-Funktion (shlwapi.h)

2023-08-26

Öffnet oder erstellt eine Datei und ruft einen Stream zum Lesen oder Schreiben in diese Datei ab.

Syntax

LWSTDAPI SHCreateStreamOnFileEx(
  [in]           LPCWSTR pszFile,
  [in]           DWORD   grfMode,
  [in]           DWORD   dwAttributes,
  [in]           BOOL    fCreate,
  [in, optional] IStream *pstmTemplate,
  [out]          IStream **ppstm
);

Parameter

[in] pszFile

Typ: LPCWSTR

Ein Zeiger auf eine NULL-Zeichenfolge, die den Dateinamen angibt.

[in] grfMode

Art: DWORD

Mindestens ein STGM-Wert , der verwendet wird, um den Dateizugriffsmodus anzugeben und anzugeben, wie das Objekt, das den Stream verfügbar macht, erstellt und gelöscht wird.

[in] dwAttributes

Art: DWORD

Mindestens ein Flagwert, der Dateiattribute für den Fall angibt, dass eine neue Datei erstellt wird. Eine vollständige Liste der möglichen Werte finden Sie im dwFlagsAndAttributes-Parameter der CreateFile-Funktion .

[in] fCreate

Typ: BOOL

Ein BOOL-Wert , mit dem in Verbindung mit grfMode angegeben wird, wie vorhandene Dateien beim Erstellen des Datenstroms behandelt werden sollen. Einzelheiten finden Sie in den Hinweisen.

[in, optional] pstmTemplate

Typ: IStream*

Reserviert.

[out] ppstm

Typ: IStream**

Empfängt einen IStream-Schnittstellenzeiger für den der Datei zugeordneten Stream.

Rückgabewert

Typ: HRESULT

Wenn diese Funktion erfolgreich ist, gibt sie S_OK zurück. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Hinweise

Die SHCreateStreamOnFileEx-Funktion erweitert die Semantik der STGM-Flags und erzeugt den gleichen Effekt wie das Aufrufen der CreateFile-Funktion .

Die Parameter grfMode und fCreate arbeiten zusammen, um anzugeben, wie sich die Funktion gegenüber vorhandenen Dateien verhalten soll.

grfMode	fCreate	Datei vorhanden?	Verhalten
STGM_CREATE	Wird ignoriert.	Yes	Die Datei wird neu erstellt.
STGM_CREATE	Wird ignoriert.	No	Die Datei ist erstellt.
STGM_FAILIFTHERE	FALSE	Yes	Die Datei wird geöffnet.
STGM_FAILIFTHERE	FALSE	No	Der Aufruf schlägt fehl.
STGM_FAILIFTHERE	TRUE	Yes	Der Aufruf schlägt fehl.
STGM_FAILIFTHERE	TRUE	No	Die Datei ist erstellt.

Anforderungen


Unterstützte Mindestversion (Client)	Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	shlwapi.h
Bibliothek	Shlwapi.lib
DLL	Shlwapi.dll (Version 6.0 oder höher)

Freigeben über