interface ICoreWebView2Environment14

Note

This reference is no longer being maintained. For the latest API reference, see WebView2 API Reference.

interface ICoreWebView2Environment14
  : public ICoreWebView2Environment13

This is ICoreWebView2Environment14 that exposes new methods to create Filesystem access related DOM objects.

Summary

Members	Descriptions
CreateObjectCollection	Create a generic object collection.
CreateWebFileSystemDirectoryHandle	Create a ICoreWebView2FileSystemHandle object from a path that represents a Web FileSystemDirectoryHandle.
CreateWebFileSystemFileHandle	Create a ICoreWebView2FileSystemHandle object from a path that represents a Web FileSystemFileHandle.

Applies to

Product	Introduced
WebView2 Win32	1.0.2651.64
WebView2 Win32 Prerelease	1.0.2646

Members

CreateObjectCollection

Create a generic object collection.

public HRESULT CreateObjectCollection(UINT32 length, IUnknown ** items, ICoreWebView2ObjectCollection ** objectCollection)

CreateWebFileSystemDirectoryHandle

Create a ICoreWebView2FileSystemHandle object from a path that represents a Web FileSystemDirectoryHandle.

public HRESULT CreateWebFileSystemDirectoryHandle(LPCWSTR path, COREWEBVIEW2_FILE_SYSTEM_HANDLE_PERMISSION permission, ICoreWebView2FileSystemHandle ** value)

The path is the path pointed by the directory and must be a syntactically correct fully qualified path, but it is not checked here whether it currently points to a directory. Any other state validation will be done when this handle is accessed from web content and will cause DOM exceptions if access operations fail. If an invalid path is passed, an E_INVALIDARG will be returned and the object will fail to create.

Permission property is used to specify whether the Handle should be created with a Read-only or Read-and-write web permission. For the permission value specified here, the Web PermissionStatus will be granted and the unspecified permission will be prompt. Therefore, the web content then does not need to call requestPermission for the permission that was specified before attempting the permitted operation, but if it does, the promise will immediately be resolved with 'granted' PermissionStatus without firing the WebView2 PermissionRequested event or prompting the user for permission. Otherwise, requestPermission will behave as the status of permission is currently Prompt, which means the PermissionRequested event will fire or the user will be prompted. Additionally, the app must have the same OS permissions that have propagated to the WebView2 browser process for the path it wishes to give the web content to make any operations on the directory. Specifically, the WebView2 browser process will run in same user, package identity, and app container of the app, but other means such as security context impersonations do not get propagated, so such permissions that the app has, will not be effective in WebView2. Note: An exception to this is, if there is a parent directory handle that has broader permissions in the same page context than specified in here, the handle will automatically inherit the most permissive permission of the parent handle when posted to that page context. i.e. If there is already a FileSystemDirectoryHandle to C:\example that has write permission on a page, even though a WebFileSystemHandle to directory C:\example\directory is created with COREWEBVIEW2_FILE_SYSTEM_HANDLE_PERMISSION_READ_ONLY permission, when posted to that page, write permission will be automatically granted to the created handle.

An app needs to be mindful that this object, when posted to the web content, provides it with unusual access to OS file system via the Web FileSystem API! The app should therefore only post objects for paths that it wants to allow access to the web content and it is not recommended that the web content "asks" for this path. The app should also check the source property of the target to ensure that it is sending to the web content of intended origin.

Once the object is passed to web content, the path must point to a directory as if it was chosen via directory picker otherwise any IO operation done on the FileSystemDirectoryHandle will throw a DOM exception.

CreateWebFileSystemFileHandle

Create a ICoreWebView2FileSystemHandle object from a path that represents a Web FileSystemFileHandle.

public HRESULT CreateWebFileSystemFileHandle(LPCWSTR path, COREWEBVIEW2_FILE_SYSTEM_HANDLE_PERMISSION permission, ICoreWebView2FileSystemHandle ** value)

The path is the path pointed by the file and must be a syntactically correct fully qualified path, but it is not checked here whether it currently points to a file. If an invalid path is passed, an E_INVALIDARG will be returned and the object will fail to create. Any other state validation will be done when this handle is accessed from web content and will cause the DOM exceptions described in FileSystemFileHandle methods if access operations fail.

Permission property is used to specify whether the Handle should be created with a Read-only or Read-and-write web permission. For the permission value specified here, the DOM PermissionStatus property will be granted and the unspecified permission will be prompt. Therefore, the web content then does not need to call requestPermission for the permission that was specified before attempting the permitted operation, but if it does, the promise will immediately be resolved with 'granted' PermissionStatus without firing the WebView2 PermissionRequested event or prompting the user for permission. Otherwise, requestPermission will behave as the status of permission is currently prompt, which means the PermissionRequested event will fire or the user will be prompted. Additionally, the app must have the same OS permissions that have propagated to the WebView2 browser process for the path it wishes to give the web content to read/write the file. Specifically, the WebView2 browser process will run in same user, package identity, and app container of the app, but other means such as security context impersonations do not get propagated, so such permissions that the app has, will not be effective in WebView2. Note: An exception to this is, if there is a parent directory handle that has broader permissions in the same page context than specified in here, the handle will automatically inherit the most permissive permission of the parent handle when posted to that page context. i.e. If there is already a FileSystemDirectoryHandle to C:\example that has write permission on a page, even though a WebFileSystemHandle to file C:\example\file.txt is created with COREWEBVIEW2_FILE_SYSTEM_HANDLE_PERMISSION_READ_ONLY permission, when posted to that page, write permission will be automatically granted to the created handle.

An app needs to be mindful that this object, when posted to the web content, provides it with unusual access to OS file system via the Web FileSystem API! The app should therefore only post objects for paths that it wants to allow access to the web content and it is not recommended that the web content "asks" for this path. The app should also check the source property of the target to ensure that it is sending to the web content of intended origin.

Once the object is passed to web content, if the content is attempting a read, the file must be existing and available to read similar to a file chosen by open file picker, otherwise the read operation will throw a DOM exception. For write operations, the file does not need to exist as FileSystemFileHandle will behave as a file path chosen by save file picker and will create or overwrite the file, but the parent directory structure pointed by the file must exist and an existing file must be available to write and delete or the write operation will throw a DOM exception.