Skip to main content

XPersistentLocalStorageGetPath

デバイス上の永続ローカル ストレージ (PLS) へのゲーム固有のパスを返します。

Syntax

Parameters

pathSize   _In_
型: size_t
PLS パス用に用意されたバッファーの文字数。この値を取得するには、XPersistentLocalStorageGetPathSize を呼び出します。 path   _Out_writes_to_(pathSize,pathUsed)
型: char
ゲームがデータを書き込むことができる PLS パス。 pathUsed   _Out_opt_
型: size_t*
指定したバッファーに書き込まれた文字数。

Return value

型: HRESULT 成功した場合は S_OK を返します。そうでない場合はエラー コードを返します。エラー コードの一覧については、エラー コード を参照してください。pathSize が PLS パスの長さより短いために関数が失敗した場合、戻り値は XBOX デバイスでは E_FAIL に、PC デバイスでは HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) に設定されます。

Remarks

この関数はタイム センシティブ スレッドで呼び出すのは安全ではありません。詳細については、タイム センシティブ スレッド を参照してください。
ゲームでは、ステージング スペース、ゲーム内 DLC、コンテンツのオンデマンド生成などのタスクのために PLS が必要になる場合があります。この領域はゲームの起動間で保持されますが、ユーザーによって削除されることもあります。PLS の詳細については、ローカル ストレージ を参照してください。 PLS はデバイスのファミリーに応じてアクセスおよび管理されます。XBOX デバイスの場合、ドライブのルートにマウントされたフォルダーへのアクセスを提供します。そのフォルダー用にプロビジョニングされるストレージ領域の量は、ゲームの MicrosoftGame.config ファイルで指定されます。プロビジョニングされた領域は、ゲームの起動中は常に利用可能です。空き容量を確保するために、ゲームが実行されていないときに、ユーザーはゲームをアンインストールせずにプロビジョニングされた領域を削除できますが、ゲームが実行中の場合はストレージの可用性が保証されます。XBOX デバイス用にこの領域をプロビジョニングするには、MicrosoftGame.config ファイルに対応するエントリが必要です。 PC デバイスの場合、PC 上のローカル ストレージ フォルダーの場所へのアクセスを提供しますが、ゲーム用に領域が特別にプロビジョニングされるわけではありません。ユーザーは、ゲームが実行中でもその領域を削除できます。ストレージの可用性は保証されず、ストレージ領域を要求するために MicrosoftGame.config ファイルにエントリを追加する必要はありません。まず、ローカル ストレージ フォルダー内の利用可能な領域がゲームの用途に十分であることを確認する必要があります。 PLS パスを取得するためにこの関数を呼び出す前に、XPersistentLocalStorageGetPathSize 関数を呼び出して PLS パスの文字数を取得し、その値を pathSize パラメーターに指定して、path パラメーターにも少なくとも同じ数の文字数を割り当てます。PLS パスに含まれる文字数より少ない文字数が pathSize に指定されている場合、エラーが発生します。 次の例は、XPersistentLocalStorageGetPathSize および XPersistentLocalStorageGetPath 関数を使用してゲームの PLS パスを取得する方法を示しています。

Requirements

ヘッダー: XPersistentLocalStorage.h ライブラリ: xgameruntime.lib サポートされているプラットフォーム: Windows、XBOX One ファミリー本体および XBOX Series 本体

Conceptual documentation

See also

XPersistentLocalStorageGetPathSize
XPersistentLocalStorage
新しい MicrosoftGame.config ファイルの使用方法
最終更新日 2026年8月24日