Gerenciar pastas de dados do usuário

Nessa plataforma, o local padrão da UDF é o diretório no qual o executável do aplicativo (.exe) está sendo executado. A UDF padrão é o caminho executável (exe) do seu aplicativo + .WebView2. O nome do arquivo da UDF é o caminho executável (exe) do seu aplicativo + .WebView2.

Por exemplo, se você executou D:\WebView2App\WebView2.exe, uma pasta UDF seria criada: D:\WebView2App\WebView2.exe.WebView2\. Como outro exemplo: WebView2APISample.exe.WebView2\.

Você deve usar a localização UDF padrão ou personalizada?

Na maioria dos casos, você deve especificar um local de UDF personalizado, em vez de usar o local padrão da UDF. Isso garante que o controle WebView2 tenha acesso de gravação para que o controle WebView2 seja capaz de criar a UDF e, em seguida, gravar nela. Consulte Especificar uma localização personalizada da UDF, abaixo.

Embalagem:

O empacotamento MSIX do Win32 é autônomo .exe.

Nessa plataforma, o local padrão da UDF é o diretório no qual o executável do aplicativo (.exe) está sendo executado. A UDF padrão é o caminho executável (exe) do seu aplicativo + .WebView2. O nome do arquivo da UDF é o caminho executável (exe) do seu aplicativo + .WebView2.

Por exemplo, se você executou D:\WebView2App\WebView2.exe, uma pasta UDF seria criada: D:\WebView2App\WebView2.exe.WebView2\. Como outro exemplo: WebView2APISample.exe.WebView2\.

Você deve usar a localização UDF padrão ou personalizada?

Na maioria dos casos, você deve especificar um local de UDF personalizado, em vez de usar o local padrão da UDF. Isso garante que o controle WebView2 tenha acesso de gravação para que o controle WebView2 seja capaz de criar a UDF e, em seguida, gravar nela. Consulte Especificar uma localização personalizada da UDF, abaixo.

Nessa plataforma, o local padrão da UDF é o diretório em que o executável do aplicativo (.exe) está sendo executado (ou um subdiretório dele).

Você deve usar a localização UDF padrão ou personalizada?

Na maioria dos casos, você deve usar o local padrão da UDF. O local padrão em que a UDF será criada terá as permissões apropriadas em tempo de execução; o local padrão da UDF é um local gravável.

Por que o local padrão é gravável:

Em tempo de execução, o ClickOnce instala automaticamente seu aplicativo host em um local para o qual o WebView2 tem permissão de gravação. O ClickOnce pode usar o local padrão da UDF e garantir que o WebView2 tenha permissões de gravação para poder criar a UDF lá.

No entanto, seu aplicativo host pode não ser capaz de usar esse local para gravar dados. Se o aplicativo host não puder gravar no local UDF padrão, consulte Especificar um local UDF personalizado, abaixo.

Limpeza:

No final da sessão, o ClickOnce limpa automaticamente.

Embalagem:

ClickOnce é um método de implantação para aplicativos transitórios leves; É um modelo híbrido. É possível persistir em um aplicativo ClickOnce, mas essa não é uma prática típica padrão.

Que tipo de aplicativo de plataforma um aplicativo ClickOnce encapsula:

Um aplicativo ClickOnce geralmente contém um aplicativo .NET.

Nessa plataforma, o local padrão da UDF é a ApplicationData\LocalFolder subpasta na pasta do pacote.

Você deve usar a localização UDF padrão ou personalizada?

Nessa plataforma, use a localização padrão da UDF.

Por que o local padrão é gravável:

O WinUI 2 (UWP) é uma plataforma empacotada; Ele é executado na área restrita e é empacotado para ser executado na área restrita, geralmente não como arquivos separados, mas como um pacote de aplicativos.

Um aplicativo WinUI 2 (UWP) é por usuário e tem acesso de gravação no local instalado.

Para UWP, o .exe está em um local protegido no qual o instalador pode gravar.

Em tempo de execução, somente durante a sessão, seu aplicativo host WebView2 recebe acesso à pasta local, de modo que o controle WebView2 é capaz de criar a UDF lá e gravar nela.

O WebView2 verifica esse tempo de execução e cria a UDF nesse local gravável.

Embalagem:

Um aplicativo WinUI 2 (UWP) é autossuficiente em relação a dependências e para implantação (DLLs), embora não seja empacotado em um único arquivo.

Um aplicativo WinUI 2 (UWP) é por usuário e tem acesso de gravação no local instalado.

Nessa plataforma, o local padrão da UDF é a ApplicationData\LocalFolder subpasta na pasta do pacote.

Você deve usar a localização UDF padrão ou personalizada?

Nessa plataforma, use o local padrão da UDF se for distribuído como empacotado. Se estiver distribuindo como não empacotado, em cenários em que o diretório de instalação está protegido, você deverá especificar um local de UDF personalizado.

Embalagem:

O WinUI 3 é uma plataforma "empacotada"; Ele é executado na área restrita e é empacotado para ser executado na área restrita, geralmente não como arquivos separados, mas como um pacote de aplicativos.

Nessa plataforma, na maioria dos casos, você deve especificar um local de UDF personalizado, em vez de usar o local de UDF padrão. Isso garante que o controle WebView2 tenha acesso de gravação para que o controle WebView2 seja capaz de criar a UDF e, em seguida, gravar nela.

Você deve especificar a mesma pasta em que todos os outros dados do aplicativo são armazenados.

Como especificar uma localização personalizada da UDF:

Use ICoreWebView2Environment e o userDataFolder parâmetro. Mas use o código abaixo, que é do WebView2Samples repositório.

Código de exemplo:

std::wstring m_userDataFolder;
m_userDataFolder = L"C:\\MyAppUserDataFolder";
auto options = Microsoft::WRL::Make<CoreWebView2ExperimentalEnvironmentOptions>();

HRESULT hr = CreateCoreWebView2EnvironmentWithOptions(
    NULL, m_userDataFolder.c_str(), options.Get(),
    Callback<ICoreWebView2CreateCoreWebView2EnvironmentCompletedHandler>(
        this, &AppWindow::OnCreateEnvironmentCompleted)
        .Get());

Para obter o código de exemplo, consulte o arquivo Win32-appropriate .cpp ou .cs próximo ao > repositório WebView2Samples WebView2APISample.

Onde os dados do navegador são armazenados na UDF:

Após a criação da sessão e da UDF, os dados do navegador do controle WebView2 são armazenados em uma subpasta de userDataFolder.

Por que você deve usar uma localização de UDF personalizada nesta plataforma:

Se você não especificar um local de UDF personalizado, o local padrão poderá produzir uma falha em tempo de execução, se estiver usando tecnologias de instalador, pois as tecnologias de instalador colocam o aplicativo e, portanto, a UDF em uma área protegida do sistema de arquivos, em que o WebView2 não é capaz de criar a UDF e, portanto, a criação de UDF geralmente falhará. O WebView2 lançará um erro para informar ao aplicativo host que a UDF não pode ser criada naquele local.

Se o aplicativo host estiver sendo executado de um local ao qual o usuário não tem acesso de gravação, o WebView2 não será capaz de criar a UDF e você receberá um erro de tempo de execução durante a inicialização do WebView2.

Nessa plataforma, na maioria dos casos, você deve especificar um local de UDF personalizado, em vez de usar o local de UDF padrão. Isso garante que o controle WebView2 tenha acesso de gravação para que o controle WebView2 seja capaz de criar a UDF e, em seguida, gravar nela.

Como especificar uma localização personalizada da UDF:

Você deve especificar a mesma pasta em que todos os outros dados do aplicativo são armazenados.

Use o método CoreWebView2Environment.CreateAsync, passando um userDataFolder parâmetro.

Código de exemplo:

string UserDataFolder;
UserDataFolder = "C:\\MyAppUserDataFolder";
_task = CoreWebView2Environment.CreateAsync(BrowserExecutableFolder, 
                                            UserDataFolder, 
                                            new CoreWebView2EnvironmentOptions(null, Language, null));

Para obter um código de exemplo, consulte o arquivo .NET (WPF & WinForms) apropriado, .cpp ou .cs, próximo ao > repositório WebView2Samples WebView2WpfBrowser.

Por que você precisa especificar uma UDF personalizada nesta plataforma:

Se você não especificar um local de UDF personalizado, o local padrão poderá gerar uma falha em tempo de execução, se estiver usando tecnologias de instalador. Isso ocorre porque as tecnologias de instalação colocam o aplicativo e, portanto, a UDF em uma área protegida do sistema de arquivos, em que o WebView2 não é capaz de criar a UDF e, portanto, a criação da UDF geralmente falhará.

O WebView2 lançará um erro para informar ao aplicativo host que a UDF não pode ser criada naquele local.

Onde os dados são armazenados na UDF: Após a criação da sessão e da UDF, os dados do navegador do controle WebView2 são armazenados em uma subpasta de userDataFolder.

Nessa plataforma, na maioria dos casos, você deve usar a localização padrão da UDF.

Se você especificar um local de UDF personalizado, certifique-se de que o local da pasta de dados do usuário tenha permissões de leitura/gravação apropriadas para o tempo de execução do aplicativo WebView2.

Como especificar uma localização personalizada da UDF:

Use o método CoreWebView2Environment.CreateAsync, passando um userDataFolder parâmetro.

Você deve especificar a mesma pasta em que todos os outros dados do aplicativo são armazenados.

Código de exemplo:

string UserDataFolder;
UserDataFolder = "C:\\MyAppUserDataFolder";
_task = CoreWebView2Environment.CreateAsync(BrowserExecutableFolder, 
                                            UserDataFolder, 
                                            new CoreWebView2EnvironmentOptions(null, Language, null));

Para obter um código de exemplo, consulte o arquivo .NET (WPF & WinForms) apropriado, .cpp ou .cs, próximo ao > repositório WebView2Samples WebView2WpfBrowser.

Onde os dados do navegador são armazenados na UDF:

Após a criação da sessão e da UDF, os dados do navegador do controle WebView2 são armazenados em uma subpasta de userDataFolder.

Nessa plataforma, use a localização padrão da UDF.

Onde os dados do navegador são armazenados na UDF:

Após a criação da sessão e da UDF, os dados do navegador do controle WebView2 são armazenados em uma subpasta de userDataFolder.

Código de exemplo:

Para obter um código de exemplo, consulte a linha 161 em /webview2_sample_uwp/Pages/SettingsPage.xaml.cs. Este aplicativo de exemplo não define uma pasta personalizada de dados do usuário. Esse código mostra o que a pasta de dados do usuário acabou sendo.

Nessa plataforma, se estiver distribuindo como não empacotado para um diretório de instalação protegido, você deverá especificar um local de UDF personalizado.

Código de exemplo:

try {
    // The default user data folder is next to the executable; however, the install
    // dir (that is, /Program Files/) is protected.
    var userDataFolder = Path.Combine(
      Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData),
      "YOURAPPNAME", "WebView2"); // You need to decide if you want to keep this 
      // folder during uninstall, or add uninstall code that removes this folder.
    Log.Info($"WebView2 user data folder: {userDataFolder}");
    var env = await CoreWebView2Environment.CreateWithOptionsAsync(
        null, userDataFolder, new CoreWebView2EnvironmentOptions());
    await WebView.EnsureCoreWebView2Async(env);
} catch (Exception ex) {
    Log.Error($"WebView.EnsureCoreWebView2Async failed: {ex.Message}");
    // Implementation of fallback error UI is not provided.
    NativeUiError = ex.ToString();
    return;
}

Onde os dados do navegador são armazenados na UDF:

Após a criação da sessão e da UDF, os dados do navegador do controle WebView2 são armazenados em uma subpasta de userDataFolder.

Use o ICoreWebView2Environment7.get_UserDataFolder de propriedade Win32. Essa página de referência da API contém um código de exemplo que mostra como ler a UserDataFolder propriedade.

Código de exemplo:

auto environment7 = m_webViewEnvironment.try_query<ICoreWebView2Environment7>();
CHECK_FEATURE_RETURN(environment7);
wil::unique_cotaskmem_string userDataFolder;
environment7->get_UserDataFolder(&userDataFolder);

Para obter exemplos de leitura da UserDataFolder propriedade, consulte os exemplos de Win32 no repositório WebView2Samples.

Código de exemplo:

Para obter exemplos de leitura da UserDataFolder propriedade, consulte os exemplos do .NET (WPF/WinForms) no repositório WebView2Samples.

Use a propriedade .NET CoreWebView2Environment.UserDataFolder.

Código de exemplo:

Para obter exemplos de leitura da propriedade, consulte o UserDataFolderrepositório > WebView2Samples webview2_sample_uwp.

Use a propriedade WinRT CoreWebView2Environment.UserDataFolder.

Código de exemplo:

private void OnGetUDFClick(object sender, RoutedEventArgs e)
{
    // This property can be used after WebView2 creation to find the actual location of the User Data Folder.
    UserDataFolder.Text = WebView2.CoreWebView2.Environment.UserDataFolder;
}

Para obter exemplos de leitura da UserDataFolder propriedade, consulte os exemplos do WinUI 2 (UWP) no repositório > WebView2Samples webview2_sample_uwp.

Use a propriedade .NET CoreWebView2Environment.UserDataFolder.

Código de exemplo:

private void OnGetUDFClick(object sender, RoutedEventArgs e)
{
    // This property can be used after WebView2 creation to find the actual location of the User Data Folder.
    UserDataFolder.Text = WebView2.CoreWebView2.Environment.UserDataFolder;
}