> ## 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.

# XGameSaveEnumerateContainerInfoByName

> XGameSaveEnumerateContainerInfoByName

# XGameSaveEnumerateContainerInfoByName

Recupera as informações de contêiner de um **XGameSaveProvider**. Fornecer um prefixo fará com que a função retorne somente palavras que tenham esse mesmo prefixo.

## Sintaxe

```cpp theme={null}
HRESULT XGameSaveEnumerateContainerInfoByName(  
         XGameSaveProviderHandle provider,  
         const char* containerNamePrefix,  
         void* context,  
         XGameSaveContainerInfoCallback* callback  
)  
```

### Parâmetros

*provider*   \_In\_\
Tipo: XGameSaveProviderHandle

**XGameSaveProvider** que contém o [XGameSaveContainerInfo](/pt-BR/reference/system/xgamesave/structs/xgamesavecontainerinfo).

*containerNamePrefix*   \_In\_opt\_z\_\
Tipo: char\*

Um prefixo que será usado para pesquisar na lista de contêineres os nomes de contêiner correspondentes.

*context*   \_In\_opt\_\
Tipo: void\*

Ponteiro que será passado para a função de retorno de chamada.

*callback*   \_In\_\
Tipo: XGameSaveContainerInfoCallback\*

A função de retorno de chamada a ser executada para cada contêiner que corresponde ao prefixo; retorne false para interromper a enumeração. Use esta função para coletar o [XGameSaveContainerInfo](/pt-BR/reference/system/xgamesave/structs/xgamesavecontainerinfo).

### Valor retornado

Tipo: HRESULT

Resultado da função.

## Comentários

Use esta função para inspecionar quais contêineres estão disponíveis para um usuário. Isso pode incluir dados que precisam ser mostrados na UX. Enumerar este conjunto não causará uma sincronização para um provedor SyncOnDemand e permitirá que o chamador realmente inspecione o status da sincronização por meio do campo needsSync de [XGameSaveContainerInfo](/pt-BR/reference/system/xgamesave/structs/xgamesavecontainerinfo). Qualquer leitura de dados de blob ou uso de um contexto de atualização em um contêiner que tenha *needsSync* definido como true forçará uma sincronização e poderá retornar vários erros de sincronização. Você pode usar [XGameSaveEnumerateContainerInfo](/pt-BR/reference/system/xgamesave/functions/xgamesaveenumeratecontainerinfo) se não precisar especificar um prefixo para os contêineres enumerados. [XGameSaveEnumerateContainerInfo](/pt-BR/reference/system/xgamesave/functions/xgamesaveenumeratecontainerinfo) retornará a lista completa de contêineres disponíveis.

```cpp theme={null}
// Enumerate Container List by prefix, if no prefix is supplied it is 
// the same as calling XGameSaveEnumerateContainerInfo. 
// NOTE: this should be safe to call from a time critical thread 
// but the we are at the mercy of the callback. 
void Sample::_EnumerateContainerInfoByName(const char* prefix) 
{ 
    HRESULT hr = XGameSaveEnumerateContainerInfoByName(_provider, prefix, this, 
        [](const XGameSaveContainerInfo* container, void* context) 
    { 
        auto self = reinterpret_cast<Sample*>(context); 
        self->_UpdateContainerList(container); 
        return true; 
    }); 
    if (FAILED(hr)) 
    { 
        _HandleContainerErrors(prefix, hr); 
    } 
  
} 
```

## Requisitos

**Cabeçalho:** XGameSave.h

**Biblioteca:** xgameruntime.lib

**Plataformas com suporte:** Windows, consoles da família XBOX One e consoles XBOX Series

## Documentação conceitual

* [Threads sensíveis ao tempo](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)

## Confira também

[XGameSave](/pt-BR/reference/system/xgamesave/xgamesave_members)\
[XGameSaveEnumerateContainerInfo](/pt-BR/reference/system/xgamesave/functions/xgamesaveenumeratecontainerinfo)\
[Depuração de salvamentos de jogos](/pt-BR/build/core-features/common/game-save/game-saves-debugging)


## Related topics

- [XGameSaveEnumerateContainerInfoByName](/reference/system/xgamesave/functions/xgamesaveenumeratecontainerinfobyname.md)
- [XGameSaveEnumerateContainerInfo](/reference/system/xgamesave/functions/xgamesaveenumeratecontainerinfo.md)