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

# XPersistentLocalStorageGetPathSize

> XPersistentLocalStorageGetPathSize

# XPersistentLocalStorageGetPathSize

Retorna o comprimento, em caracteres, do caminho para o armazenamento local persistente (PLS).

## Sintaxe

```cpp theme={null}
HRESULT XPersistentLocalStorageGetPathSize(  
         size_t* pathSize  
)  
```

### Parâmetros

*pathSize*   \_Out\_\
Tipo: size\_t\*

O comprimento, em caracteres, do caminho do PLS.

### Valor retornado

Tipo: [HRESULT](https://learn.microsoft.com/openspecs/windows_protocols/ms-erref/0642cb2f-2075-4469-918c-4441e69c548a)

Retorna **S\_OK** se for bem-sucedida; caso contrário, retorna um código de erro. Para obter uma lista de códigos de erro, consulte [Códigos de erro](https://docs.xbox.com/pt-BR/reference/errorcodes.md).

## Comentários

> [!NOTE]
>
> Não é seguro chamar esta função em um thread sensível ao tempo. Para obter mais informações, consulte [Threads sensíveis ao tempo](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads).

O valor retornado por esta função é usado no parâmetro *pathSize* da função [XPersistentLocalStorageGetPath](https://docs.xbox.com/pt-BR/reference/system/xpersistentlocalstorage/functions/xpersistentlocalstoragegetpath.md) para retornar o caminho do PLS específico do jogo no dispositivo. Para obter mais informações sobre o PLS, consulte [Armazenamento local](https://docs.xbox.com/pt-BR/build/console-features/storage/local-storage.md).

Ao chamar a função **XPersistentLocalStorageGetPath**, aloque para o parâmetro *path* de **XPersistentLocalStorageGetPath** pelo menos a quantidade de caracteres especificada no valor retornado no parâmetro *pathSize* desta função; caso contrário, ocorrerá um erro.

O exemplo a seguir ilustra como usar as funções **XPersistentLocalStorageGetPathSize** e **XPersistentLocalStorageGetPath** para obter o caminho do PLS para o seu jogo.

```cpp theme={null}
// Confirm that all of the features needed to run asynchronous tasks on 
// task queues are available.
LPCSTR Game::CheckPLSPath()
{
    // Confirm the length of the path to the local storage folder.
    LPCSTR returnPath = "";
    size_t pathSize;
    if (SUCCEEDED(XPersistentLocalStorageGetPathSize(&pathSize)))
    {
        char * path = new char[pathSize];
        size_t * pathUsed = new size_t;
        if (path != nullptr)
        {
            // Get the path to the local storage folder.
            if (SUCCEEDED(XPersistentLocalStorageGetPath(pathSize, path, pathUsed))) 
            {
                // Just to be safe, copy the bytes used in the buffer 
                // to a separate string.
                char * actualPath = new char[*pathUsed];
                strncpy(actualPath, path, *pathUsed);
                returnPath = actualPath;
            }
        }
    };

    return returnPath;
}
```

## Requisitos

**Cabeçalho:** XPersistentLocalStorage.h

**Biblioteca:** xgameruntime.lib

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

## Documentação conceitual

* [Armazenamento local no console XBOX](https://docs.xbox.com/pt-BR/build/console-features/storage/local-storage.md)
* [Threads sensíveis ao tempo](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)

## Confira também

[XPersistentLocalStorageGetPath](https://docs.xbox.com/pt-BR/reference/system/xpersistentlocalstorage/functions/xpersistentlocalstoragegetpath.md)\
[XPersistentLocalStorage](https://docs.xbox.com/pt-BR/reference/system/xpersistentlocalstorage/xpersistentlocalstorage_members.md)\
[Como usar o novo arquivo MicrosoftGame.config](https://docs.xbox.com/pt-BR/build/core-features/common/game-config/MicrosoftGameConfig-toc.md)


## Related topics

- [XPersistentLocalStorageGetPath](https://docs.xbox.com/pt-BR/reference/system/xpersistentlocalstorage/functions/xpersistentlocalstoragegetpath.md)
- [Armazenamento local no console Xbox](https://docs.xbox.com/pt-BR/build/console-features/storage/local-storage.md)
- [XPersistentLocalStorage (conteúdo da API)](https://docs.xbox.com/pt-BR/reference/system/xpersistentlocalstorage/xpersistentlocalstorage_members.md)
- [Usar wrappers C# para APIs do GDK no seu projeto do Unity](https://docs.xbox.com/pt-BR/build/gdk-and-engines/unity/unity-api-wrappers.md)
- [XPersistentLocalStorageGetSpaceInfo](https://docs.xbox.com/pt-BR/reference/system/xpersistentlocalstorage/functions/xpersistentlocalstoragegetspaceinfo.md)