> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# WdDeleteSearchOptions

> Referência para WdDeleteSearchOptions, que define padrões de inclusão e exclusão e filtros de atributos que selecionam os itens a serem excluídos com WdDeleteRemoteFiles.

# WdDeleteSearchOptions

Especifica padrões de filtro de arquivos e diretórios para uma operação de exclusão.

**Introduzida em:** [RIT 0.0.13-preview](/pt-BR/reference/remoting/release-versions#release-versions).

## Sintaxe

```cpp theme={null}
struct WdDeleteSearchOptions
{
    const char* includeFilePattern;
    const char* excludeFilePattern;
    const char* excludeDirPattern;
    uint64_t includeFileAttributes;
    uint64_t excludeFileAttributes;
    uint64_t includeDirAttributes;
    uint64_t excludeDirAttributes;
};
```

### Membros

`includeFilePattern`\
Tipo: **const char\***

Inclui arquivos que correspondem aos nomes especificados. Os caracteres curinga `*` e `?` são compatíveis, e uma lista de padrões pode ser separada por ponto e vírgula (`;`). O padrão é `nullptr`, que inclui tudo.

`excludeFilePattern`\
Tipo: **const char\***

Exclui arquivos que correspondem aos nomes especificados. Os caracteres curinga `*` e `?` são compatíveis, e uma lista de padrões pode ser separada por ponto e vírgula (`;`). O padrão é `nullptr`, que não exclui nenhum arquivo.

`excludeDirPattern`\
Tipo: **const char\***

Exclui diretórios que correspondem aos nomes especificados, não aos caminhos. Os caracteres curinga `*` e `?` são compatíveis. O padrão é `nullptr`, que não impede a exclusão de nenhum diretório.

`includeFileAttributes`\
Tipo: **uint64\_t**

Inclui arquivos que tenham qualquer um dos atributos de arquivo especificados definido. Os valores compatíveis são `FILE_ATTRIBUTE_READONLY`, `FILE_ATTRIBUTE_ARCHIVE`, `FILE_ATTRIBUTE_SYSTEM` e `FILE_ATTRIBUTE_HIDDEN`. O padrão é `0`, que inclui todos os atributos. Para obter informações adicionais sobre atributos de arquivo, confira [Constantes de atributos de arquivo](https://learn.microsoft.com/windows/win32/fileio/file-attribute-constants).

`excludeFileAttributes`\
Tipo: **uint64\_t**

Exclui arquivos que tenham qualquer um dos atributos de arquivo especificados definido. Os valores compatíveis são `FILE_ATTRIBUTE_READONLY`, `FILE_ATTRIBUTE_ARCHIVE`, `FILE_ATTRIBUTE_SYSTEM` e `FILE_ATTRIBUTE_HIDDEN`. O padrão é `0`, que não exclui nenhum atributo. Para obter informações adicionais sobre atributos de arquivo, confira [Constantes de atributos de arquivo](https://learn.microsoft.com/windows/win32/fileio/file-attribute-constants).

`includeDirAttributes`\
Tipo: **uint64\_t**

Inclui diretórios que tenham qualquer um dos atributos de arquivo especificados definido. Os valores compatíveis são `FILE_ATTRIBUTE_READONLY`, `FILE_ATTRIBUTE_ARCHIVE`, `FILE_ATTRIBUTE_SYSTEM` e `FILE_ATTRIBUTE_HIDDEN`. O padrão é `0`, que inclui todos os atributos.

`excludeDirAttributes`\
Tipo: **uint64\_t**

Exclui diretórios que tenham qualquer um dos atributos de arquivo especificados definido. Os valores compatíveis são `FILE_ATTRIBUTE_READONLY`, `FILE_ATTRIBUTE_ARCHIVE`, `FILE_ATTRIBUTE_SYSTEM` e `FILE_ATTRIBUTE_HIDDEN`. O padrão é `0`, que não exclui nenhum atributo.

## Exemplos

**Excluir somente arquivos `.pdb` e `.log`:**

```cpp theme={null}
WdDeleteSearchOptions searchOptions = {
    .includeFilePattern = "*.pdb;*.log",
    .excludeFilePattern = nullptr,
    .excludeDirPattern = nullptr,
    .includeFileAttributes = 0,
    .excludeFileAttributes = 0,
    .includeDirAttributes = 0,
    .excludeDirAttributes = 0
};
```

**Excluir tudo, exceto um diretório de dados salvos:**

```cpp theme={null}
WdDeleteSearchOptions searchOptions = {
    .includeFilePattern = nullptr,
    .excludeFilePattern = nullptr,
    .excludeDirPattern = "SaveData",
    .includeFileAttributes = 0,
    .excludeFileAttributes = 0,
    .includeDirAttributes = 0,
    .excludeDirAttributes = 0
};
```

**Excluir arquivos arquivados, mas preservar arquivos somente leitura e diretórios ocultos:**

```cpp theme={null}
WdDeleteSearchOptions searchOptions = {
    .includeFilePattern = nullptr,
    .excludeFilePattern = nullptr,
    .excludeDirPattern = nullptr,
    .includeFileAttributes = FILE_ATTRIBUTE_ARCHIVE,
    .excludeFileAttributes = FILE_ATTRIBUTE_READONLY,
    .includeDirAttributes = 0,
    .excludeDirAttributes = FILE_ATTRIBUTE_HIDDEN
};
```

> \[!NOTE]\
> Quando houver um conflito entre os padrões de inclusão e exclusão, o padrão de exclusão terá precedência e o item não será excluído.

## Comentários

Passe esta estrutura para [WdDeleteRemoteFiles](/pt-BR/reference/remoting/functions/wddeleteremotefiles) por meio do parâmetro `searchOptions` para filtrar quais arquivos e diretórios são selecionados para exclusão. Se `nullptr` for passado para `searchOptions`, todos os itens serão incluídos sem filtragem.

Essas opções se aplicam somente quando `remoteFolderPath` é resolvido para uma pasta. Elas são ignoradas quando `remoteFolderPath` é resolvido para um único arquivo.

Uma exclusão filtrada que deixa itens para trás preserva a pasta raiz mesmo quando `deleteRootFolder` está definido como `true` em [WdDeleteOptions](/pt-BR/reference/remoting/structs/wddeleteoptions), porque a pasta só é removida se ficar vazia.

## Requisitos

| Requisito | Valor |
| - | - |
| **Cabeçalho** | WdRemoteIteration.h |
| **Biblioteca** | wdremoteapi.lib |
| **SO com suporte** | Windows 11 e posterior |
| **Arquiteturas com suporte** | x64, ARM64 |

## Confira também

* [WdDeleteRemoteFiles](/pt-BR/reference/remoting/functions/wddeleteremotefiles)
* [WdDeleteOptions](/pt-BR/reference/remoting/structs/wddeleteoptions)
* [API de Iteração Remota do XBOX PC](/pt-BR/reference/remoting/remoteiteration_members)


## Related topics

- [WdDeleteSearchOptions](/reference/remoting/structs/wddeletesearchoptions.md)
- [WdDeleteOptions](/reference/remoting/structs/wddeleteoptions.md)
- [WdDeleteRemoteFiles](/reference/remoting/functions/wddeleteremotefiles.md)
- [XBOX PC Remote Iteration API](/reference/remoting/remoteiteration_members.md)
- [WdCopySearchOptions](/reference/remoting/structs/wdcopysearchoptions.md)