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

SHEvaluateSystemCommandTemplate

関数
コマンドテンプレートを評価し実行ファイルと引数に分解する。
DLLSHELL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// SHELL32.dll
#include <windows.h>

HRESULT SHEvaluateSystemCommandTemplate(
    LPCWSTR pszCmdTemplate,
    LPWSTR* ppszApplication,
    LPWSTR* ppszCommandLine,   // optional
    LPWSTR* ppszParameters   // optional
);

パラメーター

名前方向説明
pszCmdTemplateLPCWSTRinコマンドライン。パラメーターを含む場合と含まない場合があります。パラメーターが置換用のパラメーターである場合は、パラメーターが置換される前に SHEvaluateSystemCommandTemplate を呼び出す必要があります。
ppszApplicationLPWSTR*out検証済みのアプリケーションへのパスを指すポインター。この値は、CreateProcess の呼び出しでは lpApplication パラメーターとして、ShellExecute の呼び出しでは lpFile パラメーターとして渡してください。このリソースは CoTaskMemAlloc を使用して割り当てられ、不要になった時点で CoTaskMemFree を呼び出してリソースを解放するのは呼び出し側の責任です。
ppszCommandLineLPWSTR*outoptional

CreateProcess の呼び出しで使用するコマンドライン文字列テンプレートを指すポインター。コマンドラインのパラメーターはこのテンプレートに基づいて指定し、その後 CreateProcesslpCommandLine パラメーターとして渡してください。これは、PathGetArgs が常に正しく読み取れる形式であることが保証されています。このリソースは CoTaskMemAlloc を使用して割り当てられ、不要になった時点で CoTaskMemFree を呼び出してリソースを解放するのは呼び出し側の責任です。

この関数を CreateProcess の呼び出しに関連して使用しない場合、このパラメーターは NULL にできます。

ppszParametersLPWSTR*outoptional

ShellExecute の呼び出しで使用するコマンドライン文字列テンプレートを指すポインター。コマンドラインのパラメーターはこのテンプレートに基づいて指定し、その後 ShellExecutelpParameters パラメーターとして渡してください。このパラメーターは PathGetArgs を呼び出した場合と同一です。このリソースは CoTaskMemAlloc を使用して割り当てられ、不要になった時点で CoTaskMemFree を呼び出してリソースを解放するのは呼び出し側の責任です。

この関数を CreateProcess の呼び出しに関連して使用しない場合、このパラメーターは NULL にできます。

戻り値の型: HRESULT

公式ドキュメント

CreateProcess または ShellExecute の呼び出しで使用されるパラメーターに対して、厳格な検証を強制します。

戻り値

型: HRESULT

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

この関数は、呼び出し側のプロセスが、実行コンテキストに関係なくコマンドテンプレートから決定論的な動作を必要とする場合に使用します。%PATH%GetCurrentDirectory、親プロセスのディレクトリなど、現在のプロセスの状態を無視します。

この関数は、コマンドがハードコーディングされている場合に使用します。

この関数は、ShellExecuteHKEY_CLASSES_ROOT からファイルの関連付けを処理する際に使用されます。この関数の目的は、CreateProcess のコマンドラインを悪用する攻撃を減らすことです。ユーザー入力の処理を目的として設計されてはおらず、その目的で使用すると予期しない失敗を引き起こす可能性があります。

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

各言語での呼び出し定義

// SHELL32.dll
#include <windows.h>

HRESULT SHEvaluateSystemCommandTemplate(
    LPCWSTR pszCmdTemplate,
    LPWSTR* ppszApplication,
    LPWSTR* ppszCommandLine,   // optional
    LPWSTR* ppszParameters   // optional
);
[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHEvaluateSystemCommandTemplate(
    [MarshalAs(UnmanagedType.LPWStr)] string pszCmdTemplate,   // LPCWSTR
    IntPtr ppszApplication,   // LPWSTR* out
    IntPtr ppszCommandLine,   // LPWSTR* optional, out
    IntPtr ppszParameters   // LPWSTR* optional, out
);
<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHEvaluateSystemCommandTemplate(
    <MarshalAs(UnmanagedType.LPWStr)> pszCmdTemplate As String,   ' LPCWSTR
    ppszApplication As IntPtr,   ' LPWSTR* out
    ppszCommandLine As IntPtr,   ' LPWSTR* optional, out
    ppszParameters As IntPtr   ' LPWSTR* optional, out
) As Integer
End Function
' pszCmdTemplate : LPCWSTR
' ppszApplication : LPWSTR* out
' ppszCommandLine : LPWSTR* optional, out
' ppszParameters : LPWSTR* optional, out
Declare PtrSafe Function SHEvaluateSystemCommandTemplate Lib "shell32" ( _
    ByVal pszCmdTemplate As LongPtr, _
    ByVal ppszApplication As LongPtr, _
    ByVal ppszCommandLine As LongPtr, _
    ByVal ppszParameters As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHEvaluateSystemCommandTemplate = ctypes.windll.shell32.SHEvaluateSystemCommandTemplate
SHEvaluateSystemCommandTemplate.restype = ctypes.c_int
SHEvaluateSystemCommandTemplate.argtypes = [
    wintypes.LPCWSTR,  # pszCmdTemplate : LPCWSTR
    ctypes.c_void_p,  # ppszApplication : LPWSTR* out
    ctypes.c_void_p,  # ppszCommandLine : LPWSTR* optional, out
    ctypes.c_void_p,  # ppszParameters : LPWSTR* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHEvaluateSystemCommandTemplate = Fiddle::Function.new(
  lib['SHEvaluateSystemCommandTemplate'],
  [
    Fiddle::TYPE_VOIDP,  # pszCmdTemplate : LPCWSTR
    Fiddle::TYPE_VOIDP,  # ppszApplication : LPWSTR* out
    Fiddle::TYPE_VOIDP,  # ppszCommandLine : LPWSTR* optional, out
    Fiddle::TYPE_VOIDP,  # ppszParameters : LPWSTR* optional, out
  ],
  Fiddle::TYPE_INT)
#[link(name = "shell32")]
extern "system" {
    fn SHEvaluateSystemCommandTemplate(
        pszCmdTemplate: *const u16,  // LPCWSTR
        ppszApplication: *mut *mut u16,  // LPWSTR* out
        ppszCommandLine: *mut *mut u16,  // LPWSTR* optional, out
        ppszParameters: *mut *mut u16  // LPWSTR* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHELL32.dll")]
public static extern int SHEvaluateSystemCommandTemplate([MarshalAs(UnmanagedType.LPWStr)] string pszCmdTemplate, IntPtr ppszApplication, IntPtr ppszCommandLine, IntPtr ppszParameters);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHEvaluateSystemCommandTemplate' -Namespace Win32 -PassThru
# $api::SHEvaluateSystemCommandTemplate(pszCmdTemplate, ppszApplication, ppszCommandLine, ppszParameters)
#uselib "SHELL32.dll"
#func global SHEvaluateSystemCommandTemplate "SHEvaluateSystemCommandTemplate" sptr, sptr, sptr, sptr
; SHEvaluateSystemCommandTemplate pszCmdTemplate, varptr(ppszApplication), varptr(ppszCommandLine), varptr(ppszParameters)   ; 戻り値は stat
; pszCmdTemplate : LPCWSTR -> "sptr"
; ppszApplication : LPWSTR* out -> "sptr"
; ppszCommandLine : LPWSTR* optional, out -> "sptr"
; ppszParameters : LPWSTR* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHELL32.dll"
#cfunc global SHEvaluateSystemCommandTemplate "SHEvaluateSystemCommandTemplate" wstr, var, var, var
; res = SHEvaluateSystemCommandTemplate(pszCmdTemplate, ppszApplication, ppszCommandLine, ppszParameters)
; pszCmdTemplate : LPCWSTR -> "wstr"
; ppszApplication : LPWSTR* out -> "var"
; ppszCommandLine : LPWSTR* optional, out -> "var"
; ppszParameters : LPWSTR* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT SHEvaluateSystemCommandTemplate(LPCWSTR pszCmdTemplate, LPWSTR* ppszApplication, LPWSTR* ppszCommandLine, LPWSTR* ppszParameters)
#uselib "SHELL32.dll"
#cfunc global SHEvaluateSystemCommandTemplate "SHEvaluateSystemCommandTemplate" wstr, var, var, var
; res = SHEvaluateSystemCommandTemplate(pszCmdTemplate, ppszApplication, ppszCommandLine, ppszParameters)
; pszCmdTemplate : LPCWSTR -> "wstr"
; ppszApplication : LPWSTR* out -> "var"
; ppszCommandLine : LPWSTR* optional, out -> "var"
; ppszParameters : LPWSTR* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHEvaluateSystemCommandTemplate = shell32.NewProc("SHEvaluateSystemCommandTemplate")
)

// pszCmdTemplate (LPCWSTR), ppszApplication (LPWSTR* out), ppszCommandLine (LPWSTR* optional, out), ppszParameters (LPWSTR* optional, out)
r1, _, err := procSHEvaluateSystemCommandTemplate.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszCmdTemplate))),
	uintptr(ppszApplication),
	uintptr(ppszCommandLine),
	uintptr(ppszParameters),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function SHEvaluateSystemCommandTemplate(
  pszCmdTemplate: PWideChar;   // LPCWSTR
  ppszApplication: PPWideChar;   // LPWSTR* out
  ppszCommandLine: PPWideChar;   // LPWSTR* optional, out
  ppszParameters: PPWideChar   // LPWSTR* optional, out
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHEvaluateSystemCommandTemplate';
result := DllCall("SHELL32\SHEvaluateSystemCommandTemplate"
    , "WStr", pszCmdTemplate   ; LPCWSTR
    , "Ptr", ppszApplication   ; LPWSTR* out
    , "Ptr", ppszCommandLine   ; LPWSTR* optional, out
    , "Ptr", ppszParameters   ; LPWSTR* optional, out
    , "Int")   ; return: HRESULT
●SHEvaluateSystemCommandTemplate(pszCmdTemplate, ppszApplication, ppszCommandLine, ppszParameters) = DLL("SHELL32.dll", "int SHEvaluateSystemCommandTemplate(char*, void*, void*, void*)")
# 呼び出し: SHEvaluateSystemCommandTemplate(pszCmdTemplate, ppszApplication, ppszCommandLine, ppszParameters)
# pszCmdTemplate : LPCWSTR -> "char*"
# ppszApplication : LPWSTR* out -> "void*"
# ppszCommandLine : LPWSTR* optional, out -> "void*"
# ppszParameters : LPWSTR* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "shell32" fn SHEvaluateSystemCommandTemplate(
    pszCmdTemplate: [*c]const u16, // LPCWSTR
    ppszApplication: [*c][*c]u16, // LPWSTR* out
    ppszCommandLine: [*c][*c]u16, // LPWSTR* optional, out
    ppszParameters: [*c][*c]u16 // LPWSTR* optional, out
) callconv(std.os.windows.WINAPI) i32;
proc SHEvaluateSystemCommandTemplate(
    pszCmdTemplate: WideCString,  # LPCWSTR
    ppszApplication: ptr WideCString,  # LPWSTR* out
    ppszCommandLine: ptr WideCString,  # LPWSTR* optional, out
    ppszParameters: ptr WideCString  # LPWSTR* optional, out
): int32 {.importc: "SHEvaluateSystemCommandTemplate", stdcall, dynlib: "SHELL32.dll".}
pragma(lib, "shell32");
extern(Windows)
int SHEvaluateSystemCommandTemplate(
    const(wchar)* pszCmdTemplate,   // LPCWSTR
    wchar** ppszApplication,   // LPWSTR* out
    wchar** ppszCommandLine,   // LPWSTR* optional, out
    wchar** ppszParameters   // LPWSTR* optional, out
);
ccall((:SHEvaluateSystemCommandTemplate, "SHELL32.dll"), stdcall, Int32,
      (Cwstring, Ptr{Ptr{UInt16}}, Ptr{Ptr{UInt16}}, Ptr{Ptr{UInt16}}),
      pszCmdTemplate, ppszApplication, ppszCommandLine, ppszParameters)
# pszCmdTemplate : LPCWSTR -> Cwstring
# ppszApplication : LPWSTR* out -> Ptr{Ptr{UInt16}}
# ppszCommandLine : LPWSTR* optional, out -> Ptr{Ptr{UInt16}}
# ppszParameters : LPWSTR* optional, out -> Ptr{Ptr{UInt16}}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SHEvaluateSystemCommandTemplate(
    const uint16_t* pszCmdTemplate,
    uint16_t** ppszApplication,
    uint16_t** ppszCommandLine,
    uint16_t** ppszParameters);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHEvaluateSystemCommandTemplate(pszCmdTemplate, ppszApplication, ppszCommandLine, ppszParameters)
-- pszCmdTemplate : LPCWSTR
-- ppszApplication : LPWSTR* out
-- ppszCommandLine : LPWSTR* optional, out
-- ppszParameters : LPWSTR* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const SHEvaluateSystemCommandTemplate = lib.func('__stdcall', 'SHEvaluateSystemCommandTemplate', 'int32_t', ['str16', 'void *', 'void *', 'void *']);
// SHEvaluateSystemCommandTemplate(pszCmdTemplate, ppszApplication, ppszCommandLine, ppszParameters)
// pszCmdTemplate : LPCWSTR -> 'str16'
// ppszApplication : LPWSTR* out -> 'void *'
// ppszCommandLine : LPWSTR* optional, out -> 'void *'
// ppszParameters : LPWSTR* optional, out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHELL32.dll", {
  SHEvaluateSystemCommandTemplate: { parameters: ["buffer", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.SHEvaluateSystemCommandTemplate(pszCmdTemplate, ppszApplication, ppszCommandLine, ppszParameters)
// pszCmdTemplate : LPCWSTR -> "buffer"
// ppszApplication : LPWSTR* out -> "pointer"
// ppszCommandLine : LPWSTR* optional, out -> "pointer"
// ppszParameters : LPWSTR* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SHEvaluateSystemCommandTemplate(
    const uint16_t* pszCmdTemplate,
    uint16_t** ppszApplication,
    uint16_t** ppszCommandLine,
    uint16_t** ppszParameters);
C, "SHELL32.dll");
// $ffi->SHEvaluateSystemCommandTemplate(pszCmdTemplate, ppszApplication, ppszCommandLine, ppszParameters);
// pszCmdTemplate : LPCWSTR
// ppszApplication : LPWSTR* out
// ppszCommandLine : LPWSTR* optional, out
// ppszParameters : LPWSTR* optional, out
// 構造体/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);
    int SHEvaluateSystemCommandTemplate(
        WString pszCmdTemplate,   // LPCWSTR
        PointerByReference ppszApplication,   // LPWSTR* out
        PointerByReference ppszCommandLine,   // LPWSTR* optional, out
        PointerByReference ppszParameters   // LPWSTR* optional, out
    );
}
@[Link("shell32")]
lib LibSHELL32
  fun SHEvaluateSystemCommandTemplate = SHEvaluateSystemCommandTemplate(
    pszCmdTemplate : UInt16*,   # LPCWSTR
    ppszApplication : UInt16**,   # LPWSTR* out
    ppszCommandLine : UInt16**,   # LPWSTR* optional, out
    ppszParameters : UInt16**   # LPWSTR* optional, out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHEvaluateSystemCommandTemplateNative = Int32 Function(Pointer<Utf16>, Pointer<Pointer<Utf16>>, Pointer<Pointer<Utf16>>, Pointer<Pointer<Utf16>>);
typedef SHEvaluateSystemCommandTemplateDart = int Function(Pointer<Utf16>, Pointer<Pointer<Utf16>>, Pointer<Pointer<Utf16>>, Pointer<Pointer<Utf16>>);
final SHEvaluateSystemCommandTemplate = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHEvaluateSystemCommandTemplateNative, SHEvaluateSystemCommandTemplateDart>('SHEvaluateSystemCommandTemplate');
// pszCmdTemplate : LPCWSTR -> Pointer<Utf16>
// ppszApplication : LPWSTR* out -> Pointer<Pointer<Utf16>>
// ppszCommandLine : LPWSTR* optional, out -> Pointer<Pointer<Utf16>>
// ppszParameters : LPWSTR* optional, out -> Pointer<Pointer<Utf16>>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHEvaluateSystemCommandTemplate(
  pszCmdTemplate: PWideChar;   // LPCWSTR
  ppszApplication: PPWideChar;   // LPWSTR* out
  ppszCommandLine: PPWideChar;   // LPWSTR* optional, out
  ppszParameters: PPWideChar   // LPWSTR* optional, out
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHEvaluateSystemCommandTemplate';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHEvaluateSystemCommandTemplate"
  c_SHEvaluateSystemCommandTemplate :: CWString -> Ptr CWString -> Ptr CWString -> Ptr CWString -> IO Int32
-- pszCmdTemplate : LPCWSTR -> CWString
-- ppszApplication : LPWSTR* out -> Ptr CWString
-- ppszCommandLine : LPWSTR* optional, out -> Ptr CWString
-- ppszParameters : LPWSTR* optional, out -> Ptr CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shevaluatesystemcommandtemplate =
  foreign "SHEvaluateSystemCommandTemplate"
    ((ptr uint16_t) @-> (ptr (ptr uint16_t)) @-> (ptr (ptr uint16_t)) @-> (ptr (ptr uint16_t)) @-> returning int32_t)
(* pszCmdTemplate : LPCWSTR -> (ptr uint16_t) *)
(* ppszApplication : LPWSTR* out -> (ptr (ptr uint16_t)) *)
(* ppszCommandLine : LPWSTR* optional, out -> (ptr (ptr uint16_t)) *)
(* ppszParameters : LPWSTR* optional, out -> (ptr (ptr uint16_t)) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("SHEvaluateSystemCommandTemplate" shevaluate-system-command-template :convention :stdcall) :int32
  (psz-cmd-template (:string :encoding :utf-16le))   ; LPCWSTR
  (ppsz-application :pointer)   ; LPWSTR* out
  (ppsz-command-line :pointer)   ; LPWSTR* optional, out
  (ppsz-parameters :pointer))   ; LPWSTR* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHEvaluateSystemCommandTemplate = Win32::API::More->new('SHELL32',
    'int SHEvaluateSystemCommandTemplate(LPCWSTR pszCmdTemplate, LPVOID ppszApplication, LPVOID ppszCommandLine, LPVOID ppszParameters)');
# my $ret = $SHEvaluateSystemCommandTemplate->Call($pszCmdTemplate, $ppszApplication, $ppszCommandLine, $ppszParameters);
# pszCmdTemplate : LPCWSTR -> LPCWSTR
# ppszApplication : LPWSTR* out -> LPVOID
# ppszCommandLine : LPWSTR* optional, out -> LPVOID
# ppszParameters : LPWSTR* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。