Win32 API 日本語リファレンス
ホーム › UI.Shell › DoEnvironmentSubstW

DoEnvironmentSubstW

関数
文字列内の環境変数参照を実際の値に置換する。
DLLSHELL32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows XP 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

// SHELL32.dll  (Unicode / -W)
#include <windows.h>

DWORD DoEnvironmentSubstW(
    LPWSTR pszSrc,
    DWORD cchSrc
);

パラメーター

名前型方向説明
pszSrcLPWSTRinout

1 つ以上の環境変数への参照を含む、null 終端文字列へのポインター。各参照は次の形式で記述します。大文字と小文字は区別されません。 

%VariableName%

'%' 文字で囲まれていない文字列内の文字は無視され、変更されずに返されます。したがって、文字列に複数の環境変数が含まれる場合、'%' 以外の任意の文字を区切り文字として使用できます。スペースや区切り文字なしも含まれます。

この関数が正常に返ると、各 %VariableName% はその展開された値に置き換えられます。置換規則は、コマンド インタープリターで使用されるものと同じです。変数名がシステム上で見つからない場合、%variableName% は入力時のまま残されます。

展開後の文字列がバッファーに対して大きすぎてこの関数が失敗した場合、このバッファーの内容は変更されません。

cchSrcDWORDinpszSrc が指すバッファーのサイズ (文字数)。バッファーは返される文字列を保持できる十分な大きさである必要があることに注意してください。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

型: DWORD

展開後の文字列がバッファーに収まる場合、HIWORD に TRUE が返され、LOWORD に新しい pszSrc の長さ (文字数) が返されます。

展開後の文字列がバッファーに対して大きすぎる場合、HIWORD に FALSE が返され、LOWORD に cchSrc が返されます。

解説(Remarks)

パラメーターには、有効な非 NULL の値を指定する必要があります。これらの値は検証しなければなりません。検証を怠ると、予期しない結果を招く可能性があります。

pszSrc に返される文字列は通常、入力文字列より長くなるため、バッファーが展開後の文字列を保持できる十分な大きさであることを確認してください。ANSI 文字列の場合、cchSrc バッファーに割り当てるサイズは、Unicode 文字列用のバッファーより 1 つ大きくする必要があります。ANSI 文字列を扱う場合は、最小限の正しいバッファー サイズを求めるために バッファー サイズ = 文字列の長さ + 終端の null 文字 + 1 という式を使用してください。

環境変数はユーザーやアプリケーションによって追加できるため、完全な一覧はシステムに依存します。次の環境変数は標準であり、対話型アプリケーションとサービスの両方で利用できます。

次の環境変数は対話型アプリケーションでのみ利用できます。 ファイル システム フォルダーに対応する環境変数は、同等の CSIDL または KNOWNFOLDERID 値にマップでき、SHGetFolderLocation または SHGetKnownFolderPath を通じて取得できます。CSIDL や KNOWNFOLDERID は環境変数名よりも信頼性が高いため、可能な限りこれらを使用してください。

Examples

次のコンソール アプリケーションは、DoEnvironmentSubstW の使用方法を示しています。


#include "stdafx.h"
#include "windows.h"
#include "windef.h"
#include "shellapi.h"

int _tmain(int argc, _TCHAR* argv[])
{
    WCHAR szSrc[MAX_PATH] = L"%OS%;%HOMEPATH%";

    DWORD result = DoEnvironmentSubstW(szSrc, MAX_PATH);

    WORD success = HIWORD(result);
    WORD string_length = LOWORD(result);

    return 0;
}
メモ

shellapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして DoEnvironmentSubst を定義します。エンコーディング ニュートラルなエイリアスの使用を、エンコーディング ニュートラルでないコードと混在させると、コンパイル エラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// SHELL32.dll  (Unicode / -W)
#include <windows.h>

DWORD DoEnvironmentSubstW(
    LPWSTR pszSrc,
    DWORD cchSrc
);
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint DoEnvironmentSubstW(
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszSrc,   // LPWSTR in/out
    uint cchSrc   // DWORD
);
<DllImport("SHELL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function DoEnvironmentSubstW(
    <MarshalAs(UnmanagedType.LPWStr)> pszSrc As System.Text.StringBuilder,   ' LPWSTR in/out
    cchSrc As UInteger   ' DWORD
) As UInteger
End Function
' pszSrc : LPWSTR in/out
' cchSrc : DWORD
Declare PtrSafe Function DoEnvironmentSubstW Lib "shell32" ( _
    ByVal pszSrc As LongPtr, _
    ByVal cchSrc As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DoEnvironmentSubstW = ctypes.windll.shell32.DoEnvironmentSubstW
DoEnvironmentSubstW.restype = wintypes.DWORD
DoEnvironmentSubstW.argtypes = [
    wintypes.LPWSTR,  # pszSrc : LPWSTR in/out
    wintypes.DWORD,  # cchSrc : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
DoEnvironmentSubstW = Fiddle::Function.new(
  lib['DoEnvironmentSubstW'],
  [
    Fiddle::TYPE_VOIDP,  # pszSrc : LPWSTR in/out
    -Fiddle::TYPE_INT,  # cchSrc : DWORD
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shell32")]
extern "system" {
    fn DoEnvironmentSubstW(
        pszSrc: *mut u16,  // LPWSTR in/out
        cchSrc: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode)]
public static extern uint DoEnvironmentSubstW([MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszSrc, uint cchSrc);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_DoEnvironmentSubstW' -Namespace Win32 -PassThru
# $api::DoEnvironmentSubstW(pszSrc, cchSrc)
#uselib "SHELL32.dll"
#func global DoEnvironmentSubstW "DoEnvironmentSubstW" wptr, wptr
; DoEnvironmentSubstW varptr(pszSrc), cchSrc   ; 戻り値は stat
; pszSrc : LPWSTR in/out -> "wptr"
; cchSrc : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "SHELL32.dll"
#cfunc global DoEnvironmentSubstW "DoEnvironmentSubstW" var, int
; res = DoEnvironmentSubstW(pszSrc, cchSrc)
; pszSrc : LPWSTR in/out -> "var"
; cchSrc : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; DWORD DoEnvironmentSubstW(LPWSTR pszSrc, DWORD cchSrc)
#uselib "SHELL32.dll"
#cfunc global DoEnvironmentSubstW "DoEnvironmentSubstW" var, int
; res = DoEnvironmentSubstW(pszSrc, cchSrc)
; pszSrc : LPWSTR in/out -> "var"
; cchSrc : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procDoEnvironmentSubstW = shell32.NewProc("DoEnvironmentSubstW")
)

// pszSrc (LPWSTR in/out), cchSrc (DWORD)
r1, _, err := procDoEnvironmentSubstW.Call(
	uintptr(pszSrc),
	uintptr(cchSrc),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function DoEnvironmentSubstW(
  pszSrc: PWideChar;   // LPWSTR in/out
  cchSrc: DWORD   // DWORD
): DWORD; stdcall;
  external 'SHELL32.dll' name 'DoEnvironmentSubstW';
result := DllCall("SHELL32\DoEnvironmentSubstW"
    , "Ptr", pszSrc   ; LPWSTR in/out
    , "UInt", cchSrc   ; DWORD
    , "UInt")   ; return: DWORD
●DoEnvironmentSubstW(pszSrc, cchSrc) = DLL("SHELL32.dll", "dword DoEnvironmentSubstW(char*, dword)")
# 呼び出し: DoEnvironmentSubstW(pszSrc, cchSrc)
# pszSrc : LPWSTR in/out -> "char*"
# cchSrc : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "shell32" fn DoEnvironmentSubstW(
    pszSrc: [*c]u16, // LPWSTR in/out
    cchSrc: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc DoEnvironmentSubstW(
    pszSrc: ptr uint16,  # LPWSTR in/out
    cchSrc: uint32  # DWORD
): uint32 {.importc: "DoEnvironmentSubstW", stdcall, dynlib: "SHELL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shell32");
extern(Windows)
uint DoEnvironmentSubstW(
    wchar* pszSrc,   // LPWSTR in/out
    uint cchSrc   // DWORD
);
ccall((:DoEnvironmentSubstW, "SHELL32.dll"), stdcall, UInt32,
      (Ptr{UInt16}, UInt32),
      pszSrc, cchSrc)
# pszSrc : LPWSTR in/out -> Ptr{UInt16}
# cchSrc : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t DoEnvironmentSubstW(
    uint16_t* pszSrc,
    uint32_t cchSrc);
]]
local shell32 = ffi.load("shell32")
-- shell32.DoEnvironmentSubstW(pszSrc, cchSrc)
-- pszSrc : LPWSTR in/out
-- cchSrc : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const DoEnvironmentSubstW = lib.func('__stdcall', 'DoEnvironmentSubstW', 'uint32_t', ['uint16_t *', 'uint32_t']);
// DoEnvironmentSubstW(pszSrc, cchSrc)
// pszSrc : LPWSTR in/out -> 'uint16_t *'
// cchSrc : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHELL32.dll", {
  DoEnvironmentSubstW: { parameters: ["buffer", "u32"], result: "u32" },
});
// lib.symbols.DoEnvironmentSubstW(pszSrc, cchSrc)
// pszSrc : LPWSTR in/out -> "buffer"
// cchSrc : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t DoEnvironmentSubstW(
    uint16_t* pszSrc,
    uint32_t cchSrc);
C, "SHELL32.dll");
// $ffi->DoEnvironmentSubstW(pszSrc, cchSrc);
// pszSrc : LPWSTR in/out
// cchSrc : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Shell32 extends StdCallLibrary {
    Shell32 INSTANCE = Native.load("shell32", Shell32.class, W32APIOptions.UNICODE_OPTIONS);
    int DoEnvironmentSubstW(
        char[] pszSrc,   // LPWSTR in/out
        int cchSrc   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shell32")]
lib LibSHELL32
  fun DoEnvironmentSubstW = DoEnvironmentSubstW(
    pszSrc : UInt16*,   # LPWSTR in/out
    cchSrc : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DoEnvironmentSubstWNative = Uint32 Function(Pointer<Utf16>, Uint32);
typedef DoEnvironmentSubstWDart = int Function(Pointer<Utf16>, int);
final DoEnvironmentSubstW = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<DoEnvironmentSubstWNative, DoEnvironmentSubstWDart>('DoEnvironmentSubstW');
// pszSrc : LPWSTR in/out -> Pointer<Utf16>
// cchSrc : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DoEnvironmentSubstW(
  pszSrc: PWideChar;   // LPWSTR in/out
  cchSrc: DWORD   // DWORD
): DWORD; stdcall;
  external 'SHELL32.dll' name 'DoEnvironmentSubstW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DoEnvironmentSubstW"
  c_DoEnvironmentSubstW :: CWString -> Word32 -> IO Word32
-- pszSrc : LPWSTR in/out -> CWString
-- cchSrc : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let doenvironmentsubstw =
  foreign "DoEnvironmentSubstW"
    ((ptr uint16_t) @-> uint32_t @-> returning uint32_t)
(* pszSrc : LPWSTR in/out -> (ptr uint16_t) *)
(* cchSrc : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("DoEnvironmentSubstW" do-environment-subst-w :convention :stdcall) :uint32
  (psz-src :pointer)   ; LPWSTR in/out
  (cch-src :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DoEnvironmentSubstW = Win32::API::More->new('SHELL32',
    'DWORD DoEnvironmentSubstW(LPWSTR pszSrc, DWORD cchSrc)');
# my $ret = $DoEnvironmentSubstW->Call($pszSrc, $cchSrc);
# pszSrc : LPWSTR in/out -> LPWSTR
# cchSrc : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い