Skip to main content

XPersistentLocalStorageGetPath

Retorna o caminho específico do jogo para o armazenamento local persistente (PLS) no dispositivo.

Sintaxe

Parâmetros

pathSize   _In_
Tipo: size_t
O número de caracteres no buffer fornecido para o caminho do PLS. Para obter esse valor, chame XPersistentLocalStorageGetPathSize. path   _Out_writes_to_(pathSize,pathUsed)
Tipo: char
O caminho do PLS no qual seu jogo pode gravar dados. pathUsed   _Out_opt_
Tipo: size_t*
O número de caracteres gravados no buffer fornecido.

Valor retornado

Tipo: HRESULT 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. Se a função falhar porque pathSize é menor que o comprimento do caminho do PLS, o valor retornado será definido como E_FAIL para dispositivos XBOX e como HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) para dispositivos PC.

Comentários

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.
Os jogos podem exigir PLS para tarefas como espaço de preparação, DLC no jogo e geração de conteúdo sob demanda. Embora o espaço seja mantido entre as ativações do jogo, ele também pode ser excluído pelos usuários. Para obter mais informações sobre o PLS, consulte Armazenamento local O PLS é acessado e gerenciado de acordo com a família do dispositivo. Para dispositivos XBOX, fornecemos acesso a uma pasta montada na raiz de uma unidade. A quantidade de espaço de armazenamento provisionada para essa pasta é especificada no arquivo MicrosoftGame.config do seu jogo. O espaço provisionado fica disponível e sempre presente durante uma inicialização do seu jogo. Para liberar espaço, os usuários podem excluir o espaço provisionado sem desinstalar o jogo, quando o jogo não estiver em execução; no entanto, quando o jogo estiver em execução, a disponibilidade do armazenamento é garantida. Para que esse espaço seja provisionado para dispositivos XBOX, você deve ter uma entrada correspondente no seu arquivo MicrosoftGame.config. Para dispositivos PC, fornecemos acesso ao local de uma pasta de armazenamento local no PC, mas o espaço não é provisionado especificamente para o seu jogo. Os usuários podem excluir esse espaço mesmo enquanto o jogo estiver em execução. A disponibilidade do armazenamento não é garantida, e uma entrada no seu arquivo MicrosoftGame.config não é necessária para reivindicar espaço de armazenamento. Primeiro, você deve confirmar que o espaço disponível na pasta de armazenamento local é suficiente para as finalidades do seu jogo. Antes de chamar esta função para recuperar o caminho do PLS, chame a função XPersistentLocalStorageGetPathSize para obter o número de caracteres no caminho do PLS; em seguida, forneça esse valor no parâmetro pathSize e aloque pelo menos essa quantidade de caracteres para o parâmetro path. Ocorrerá um erro se forem especificados em pathSize menos caracteres do que os contidos no caminho do PLS. O exemplo a seguir ilustra como usar as funções XPersistentLocalStorageGetPathSize e XPersistentLocalStorageGetPath para obter o caminho do PLS para o seu jogo.

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

Confira também

XPersistentLocalStorageGetPathSize
XPersistentLocalStorage
Como usar o novo arquivo MicrosoftGame.config
Last modified on October 6, 2026