ExpandEnvironmentStringsA 関数 (processenv.h)

  • [アーティクル]

環境変数の文字列を展開し、現在のユーザーに対して定義されている値に置き換えます。

特定のユーザーまたはシステムの環境ブロックを指定するには、ExpandEnvironmentStringsForUser 関数を使用します。

構文

DWORD ExpandEnvironmentStringsA(
  [in]            LPCSTR lpSrc,
  [out, optional] LPSTR  lpDst,
  [in]            DWORD  nSize
);

パラメーター

[in] lpSrc

variableName%の形式で 1 つ以上の環境変数文字列 %含むバッファー。 このような参照ごとに、%variableName% 部分は、その環境変数の現在の値に置き換えられます。

環境変数名を調べている場合、大文字と小文字は無視されます。 名前が見つからない場合、%variableName% 部分は省略されずに残ります。

この関数は、Cmd.exe がサポートするすべての機能をサポートしているわけではないことに注意してください。 たとえば、variableName %:str1=str2% または %variableName:~オフセット、長さ%をサポートしていません。

[out, optional] lpDst

lpSrc バッファー内の環境変数文字列を展開した結果を受け取るバッファーへのポインター。 このバッファーは、lpSrc バッファーと同じにすることはできません。

[in] nSize

lpDst パラメーターが指すバッファーに格納できる最大文字数。 ANSI 文字列を使用する場合、バッファー サイズは文字列の長さと終端の null 文字に 1 を加えたものにする必要があります。 Unicode 文字列を使用する場合、バッファー サイズは文字列の長さと終端の null 文字を加算する必要があります。

戻り値

関数が成功した場合、戻り値は、終端の null 文字を含め、宛先バッファーに格納 TCHAR の数です。 展開された文字列を保持するには宛先バッファーが小さすぎる場合、戻り値は必要なバッファー サイズ (文字数) です。

関数が失敗した場合、戻り値は 0 です。 拡張エラー情報を取得するには、GetLastError呼び出します。

備考

Windows Server 2003 および Windows XP: lpSrc および lpDst バッファー のサイズは 32K に制限されます。

完全修飾パス内のフォルダー名を関連する環境変数文字列に置き換えるには、PathUnExpandEnvStrings 関数を使用します。

プロセスの環境変数の一覧を取得するには、GetEnvironmentStrings 関数を使用します。

例

例については、「システム情報の取得を参照してください。

手記

processenv.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして ExpandEnvironmentStrings を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルまたは実行時エラーが発生する不一致につながる可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。

必要条件

要件 価値
サポートされる最小クライアント Windows 2000 Professional [デスクトップ アプリ |UWP アプリ]
サポートされる最小サーバー Windows 2000 Server [デスクトップ アプリ |UWP アプリ]
ターゲット プラットフォーム の ウィンドウズ
ヘッダー processenv.h (Windows.h を含む)
ライブラリ Kernel32.lib
DLL Kernel32.dll

関連項目

環境変数の

システム情報関数