DoEnvironmentSubstW

1 つ以上の環境変数への参照を含む入力文字列を解析し、それらを完全に展開した値に置き換える。(Unicode)

DoEnvironmentSubstW pszSrc, cchSrc

pszSrc : [wstr] 型: LPTSTR 1 つ以上の環境変数への参照を次の形式で含むヌル終端文字列へのポインタ。大文字小文字は区別されない。
cchSrc : [int] 型: UINT pszSrc が指すバッファのサイズ(文字数)。バッファは返される文字列を格納するのに十分な大きさが必要であることに注意。

(プラグイン / モジュール : shell32.dll)

解説

1 つ以上の環境変数への参照を含む入力文字列を解析し、それらを完全に展開した値に置き換える。(Unicode)

[戻り値]
型: DWORD 展開された文字列がバッファに収まる場合、HIWORD に TRUE が返り、新しい pszSrc の長さ(文字数)が
LOWORD に返る。
展開された文字列がバッファに対して大きすぎる場合、HIWORD に FALSE が返り、LOWORD に cchSrc が返る。

[備考]
パラメータには有効で NULL
以外の値が含まれていなければならない。これらの値は呼び出し側で検証する必要がある。検証を怠ると予期しない結果になる可能性がある。pszSrc
に返される文字列は通常入力文字列より長くなるため、展開後の文字列を格納するのに十分な大きさのバッファを用意すること。ANSI 文字列の場合
cchSrc バッファに割り当てるサイズは Unicode 文字列のバッファより 1 大きくする必要がある。ANSI
文字列を扱う際は「バッファサイズ = 文字列長 + 終端ヌル文字 +
1」という式で必要な最小バッファサイズを求める。環境変数はユーザやアプリケーションが追加できるため、その完全なリストはシステム依存である。次の環境変数は標準であり、対話型アプリケーションおよびサービスの両方で利用できる。
(以下省略)

情報

プラグイン / モジュールshell32.dll
バージョン1.0
作成日2026/04/16
著作者IronHSP / CsWin32 bridge
URLhttps://github.com/inovia/IronHSP
備考Win32 API の shell32.dll 関数群。CsWin32 + win32metadata から自動生成。
hsp3net 専用 (intptr / NSTRUCT / wstr を使用)。
タイプ拡張命令
グループWin32API
対応環境
  • Windows 版 HSP
hs ファイルhsphelp\win32_shell32_gen2.hs