Skip to main content

XPersistentLocalStorageGetPath

Devuelve la ruta de acceso específica del juego al almacenamiento local persistente (PLS) en el dispositivo.

Sintaxis

Parámetros

pathSize   _In_
Tipo: size_t
El número de caracteres del búfer proporcionado para la ruta de acceso de PLS. Para obtener este valor, llame a XPersistentLocalStorageGetPathSize. path   _Out_writes_to_(pathSize,pathUsed)
Tipo: char
La ruta de acceso de PLS en la que el juego puede escribir datos. pathUsed   _Out_opt_
Tipo: size_t*
El número de caracteres escritos en el búfer proporcionado.

Valor devuelto

Tipo: HRESULT Devuelve S_OK si se realiza correctamente; de lo contrario, devuelve un código de error. Para obtener una lista de códigos de error, consulte Códigos de error. Si la función produce un error porque pathSize es menor que la longitud de la ruta de acceso de PLS, el valor devuelto se establece en E_FAIL para dispositivos XBOX y en HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) para dispositivos PC.

Comentarios

No es seguro llamar a esta función en un subproceso sensible al tiempo. Para obtener más información, consulte Subprocesos sensibles al tiempo.
Los juegos pueden necesitar PLS para tareas como el espacio de almacenamiento provisional, el DLC dentro del juego y la generación de contenido a petición. Aunque el espacio se conserva entre activaciones del juego, los usuarios también pueden eliminarlo. Para obtener más información sobre PLS, consulte Almacenamiento local El acceso a PLS y su administración dependen de la familia del dispositivo. Para los dispositivos XBOX, proporcionamos acceso a una carpeta montada en la raíz de una unidad. La cantidad de espacio de almacenamiento aprovisionado para esa carpeta se especifica en el archivo MicrosoftGame.config del juego. El espacio aprovisionado está disponible y siempre presente durante un inicio del juego. Para liberar espacio, los usuarios pueden eliminar el espacio aprovisionado sin desinstalar el juego, cuando el juego no se está ejecutando; sin embargo, cuando el juego está en ejecución, la disponibilidad del almacenamiento está garantizada. Para obtener este espacio aprovisionado en dispositivos XBOX, debe tener una entrada correspondiente en el archivo MicrosoftGame.config. Para los dispositivos PC, proporcionamos acceso a la ubicación de una carpeta de almacenamiento local en el PC, pero no se aprovisiona espacio específicamente para el juego. Los usuarios pueden eliminar ese espacio incluso mientras el juego se está ejecutando. La disponibilidad del almacenamiento no está garantizada y no se requiere una entrada en el archivo MicrosoftGame.config para reclamar espacio de almacenamiento. Primero debe confirmar que el espacio disponible en la carpeta de almacenamiento local es suficiente para los propósitos del juego. Antes de llamar a esta función para recuperar la ruta de acceso de PLS, llame a la función XPersistentLocalStorageGetPathSize para obtener el número de caracteres de la ruta de acceso de PLS, luego proporcione ese valor en el parámetro pathSize y asigne al menos esa cantidad de caracteres para el parámetro path. Se producirá un error si se especifican menos caracteres en pathSize de los que contiene la ruta de acceso de PLS. El ejemplo siguiente muestra cómo usar las funciones XPersistentLocalStorageGetPathSize y XPersistentLocalStorageGetPath para obtener la ruta de acceso de PLS del juego.

Requisitos

Encabezado: XPersistentLocalStorage.h Biblioteca: xgameruntime.lib Plataformas compatibles: Windows, consolas de la familia XBOX One y consolas XBOX Series

Documentación conceptual

Consulte también

XPersistentLocalStorageGetPathSize
XPersistentLocalStorage
Cómo usar el nuevo archivo MicrosoftGame.config
Última modificación el 28 de agosto de 2026