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

SHCreateThread

関数
シェル用のワーカースレッドを作成して開始する。
DLLSHLWAPI.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL SHCreateThread(
    LPTHREAD_START_ROUTINE pfnThreadProc,
    void* pData,   // optional
    DWORD flags,
    LPTHREAD_START_ROUTINE pfnCallback   // optional
);

パラメーター

名前方向説明
pfnThreadProcLPTHREAD_START_ROUTINEinLPTHREAD_START_ROUTINE 型のアプリケーション定義関数へのポインターです。新しいスレッドが正常に作成された場合、このアプリケーション定義関数はそのスレッドのコンテキストで呼び出されます。SHCreateThread は、呼び出し元に戻る前にこのパラメーターが指す関数の完了を待ちません。アプリケーション定義関数の戻り値は、スレッドの終了コードになります。
pDatavoid*inoptional初期化データを含む省略可能なアプリケーション定義のデータ構造体へのポインターです。これは pfnThreadProc が指す関数に渡され、必要に応じて pfnCallback にも渡されます。この値は NULL にすることができます。
flagsDWORDin関数の動作を制御するフラグです。1 つ以上の CTF 定数を指定します。
pfnCallbackLPTHREAD_START_ROUTINEinoptionalLPTHREAD_START_ROUTINE 型の省略可能なアプリケーション定義関数へのポインターです。この関数は、pfnThreadProc が指す関数が呼び出される前に、作成されたスレッドのコンテキストで呼び出されます。また、引数として pData を受け取ります。SHCreateThread は、呼び出し元に戻る前に pfnCallback が指す関数が返るのを待ちます。pfnCallback が指す関数の戻り値は無視されます。

戻り値の型: BOOL

公式ドキュメント

スレッドを作成します。

戻り値

型: BOOL

スレッドが正常に作成された場合は TRUE を、それ以外の場合は FALSE を返します。失敗した場合は、ここに示すように GetLastError を使用して具体的なエラー値を取得します。

if (!SHCreateThread(...))
{
    hr = HRESULT_FROM_WIN32( GetLastError() );
}
else
{
    ....
}

解説(Remarks)

pfnThreadProc および pfnCallback が指す関数は、次の形式である必要があります。

DWORD WINAPI ThreadProc(LPVOID pData)
{
  ...
}

関数名は任意です。pData パラメーターは、初期化情報を含むアプリケーション定義のデータ構造体を指します。

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

各言語での呼び出し定義

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

BOOL SHCreateThread(
    LPTHREAD_START_ROUTINE pfnThreadProc,
    void* pData,   // optional
    DWORD flags,
    LPTHREAD_START_ROUTINE pfnCallback   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SHCreateThread(
    IntPtr pfnThreadProc,   // LPTHREAD_START_ROUTINE
    IntPtr pData,   // void* optional
    uint flags,   // DWORD
    IntPtr pfnCallback   // LPTHREAD_START_ROUTINE optional
);
<DllImport("SHLWAPI.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SHCreateThread(
    pfnThreadProc As IntPtr,   ' LPTHREAD_START_ROUTINE
    pData As IntPtr,   ' void* optional
    flags As UInteger,   ' DWORD
    pfnCallback As IntPtr   ' LPTHREAD_START_ROUTINE optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pfnThreadProc : LPTHREAD_START_ROUTINE
' pData : void* optional
' flags : DWORD
' pfnCallback : LPTHREAD_START_ROUTINE optional
Declare PtrSafe Function SHCreateThread Lib "shlwapi" ( _
    ByVal pfnThreadProc As LongPtr, _
    ByVal pData As LongPtr, _
    ByVal flags As Long, _
    ByVal pfnCallback As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHCreateThread = ctypes.windll.shlwapi.SHCreateThread
SHCreateThread.restype = wintypes.BOOL
SHCreateThread.argtypes = [
    ctypes.c_void_p,  # pfnThreadProc : LPTHREAD_START_ROUTINE
    ctypes.POINTER(None),  # pData : void* optional
    wintypes.DWORD,  # flags : DWORD
    ctypes.c_void_p,  # pfnCallback : LPTHREAD_START_ROUTINE optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
SHCreateThread = Fiddle::Function.new(
  lib['SHCreateThread'],
  [
    Fiddle::TYPE_VOIDP,  # pfnThreadProc : LPTHREAD_START_ROUTINE
    Fiddle::TYPE_VOIDP,  # pData : void* optional
    -Fiddle::TYPE_INT,  # flags : DWORD
    Fiddle::TYPE_VOIDP,  # pfnCallback : LPTHREAD_START_ROUTINE optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "shlwapi")]
extern "system" {
    fn SHCreateThread(
        pfnThreadProc: *const core::ffi::c_void,  // LPTHREAD_START_ROUTINE
        pData: *mut (),  // void* optional
        flags: u32,  // DWORD
        pfnCallback: *const core::ffi::c_void  // LPTHREAD_START_ROUTINE optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", SetLastError = true)]
public static extern bool SHCreateThread(IntPtr pfnThreadProc, IntPtr pData, uint flags, IntPtr pfnCallback);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHCreateThread' -Namespace Win32 -PassThru
# $api::SHCreateThread(pfnThreadProc, pData, flags, pfnCallback)
#uselib "SHLWAPI.dll"
#func global SHCreateThread "SHCreateThread" sptr, sptr, sptr, sptr
; SHCreateThread pfnThreadProc, pData, flags, pfnCallback   ; 戻り値は stat
; pfnThreadProc : LPTHREAD_START_ROUTINE -> "sptr"
; pData : void* optional -> "sptr"
; flags : DWORD -> "sptr"
; pfnCallback : LPTHREAD_START_ROUTINE optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHLWAPI.dll"
#cfunc global SHCreateThread "SHCreateThread" sptr, sptr, int, sptr
; res = SHCreateThread(pfnThreadProc, pData, flags, pfnCallback)
; pfnThreadProc : LPTHREAD_START_ROUTINE -> "sptr"
; pData : void* optional -> "sptr"
; flags : DWORD -> "int"
; pfnCallback : LPTHREAD_START_ROUTINE optional -> "sptr"
; BOOL SHCreateThread(LPTHREAD_START_ROUTINE pfnThreadProc, void* pData, DWORD flags, LPTHREAD_START_ROUTINE pfnCallback)
#uselib "SHLWAPI.dll"
#cfunc global SHCreateThread "SHCreateThread" intptr, intptr, int, intptr
; res = SHCreateThread(pfnThreadProc, pData, flags, pfnCallback)
; pfnThreadProc : LPTHREAD_START_ROUTINE -> "intptr"
; pData : void* optional -> "intptr"
; flags : DWORD -> "int"
; pfnCallback : LPTHREAD_START_ROUTINE optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procSHCreateThread = shlwapi.NewProc("SHCreateThread")
)

// pfnThreadProc (LPTHREAD_START_ROUTINE), pData (void* optional), flags (DWORD), pfnCallback (LPTHREAD_START_ROUTINE optional)
r1, _, err := procSHCreateThread.Call(
	uintptr(pfnThreadProc),
	uintptr(pData),
	uintptr(flags),
	uintptr(pfnCallback),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SHCreateThread(
  pfnThreadProc: Pointer;   // LPTHREAD_START_ROUTINE
  pData: Pointer;   // void* optional
  flags: DWORD;   // DWORD
  pfnCallback: Pointer   // LPTHREAD_START_ROUTINE optional
): BOOL; stdcall;
  external 'SHLWAPI.dll' name 'SHCreateThread';
result := DllCall("SHLWAPI\SHCreateThread"
    , "Ptr", pfnThreadProc   ; LPTHREAD_START_ROUTINE
    , "Ptr", pData   ; void* optional
    , "UInt", flags   ; DWORD
    , "Ptr", pfnCallback   ; LPTHREAD_START_ROUTINE optional
    , "Int")   ; return: BOOL
●SHCreateThread(pfnThreadProc, pData, flags, pfnCallback) = DLL("SHLWAPI.dll", "bool SHCreateThread(void*, void*, dword, void*)")
# 呼び出し: SHCreateThread(pfnThreadProc, pData, flags, pfnCallback)
# pfnThreadProc : LPTHREAD_START_ROUTINE -> "void*"
# pData : void* optional -> "void*"
# flags : DWORD -> "dword"
# pfnCallback : LPTHREAD_START_ROUTINE optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "shlwapi" fn SHCreateThread(
    pfnThreadProc: ?*anyopaque, // LPTHREAD_START_ROUTINE
    pData: ?*anyopaque, // void* optional
    flags: u32, // DWORD
    pfnCallback: ?*anyopaque // LPTHREAD_START_ROUTINE optional
) callconv(std.os.windows.WINAPI) i32;
proc SHCreateThread(
    pfnThreadProc: pointer,  # LPTHREAD_START_ROUTINE
    pData: pointer,  # void* optional
    flags: uint32,  # DWORD
    pfnCallback: pointer  # LPTHREAD_START_ROUTINE optional
): int32 {.importc: "SHCreateThread", stdcall, dynlib: "SHLWAPI.dll".}
pragma(lib, "shlwapi");
extern(Windows)
int SHCreateThread(
    void* pfnThreadProc,   // LPTHREAD_START_ROUTINE
    void* pData,   // void* optional
    uint flags,   // DWORD
    void* pfnCallback   // LPTHREAD_START_ROUTINE optional
);
ccall((:SHCreateThread, "SHLWAPI.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}, UInt32, Ptr{Cvoid}),
      pfnThreadProc, pData, flags, pfnCallback)
# pfnThreadProc : LPTHREAD_START_ROUTINE -> Ptr{Cvoid}
# pData : void* optional -> Ptr{Cvoid}
# flags : DWORD -> UInt32
# pfnCallback : LPTHREAD_START_ROUTINE optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SHCreateThread(
    void* pfnThreadProc,
    void* pData,
    uint32_t flags,
    void* pfnCallback);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.SHCreateThread(pfnThreadProc, pData, flags, pfnCallback)
-- pfnThreadProc : LPTHREAD_START_ROUTINE
-- pData : void* optional
-- flags : DWORD
-- pfnCallback : LPTHREAD_START_ROUTINE optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const SHCreateThread = lib.func('__stdcall', 'SHCreateThread', 'int32_t', ['void *', 'void *', 'uint32_t', 'void *']);
// SHCreateThread(pfnThreadProc, pData, flags, pfnCallback)
// pfnThreadProc : LPTHREAD_START_ROUTINE -> 'void *'
// pData : void* optional -> 'void *'
// flags : DWORD -> 'uint32_t'
// pfnCallback : LPTHREAD_START_ROUTINE optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("SHLWAPI.dll", {
  SHCreateThread: { parameters: ["pointer", "pointer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.SHCreateThread(pfnThreadProc, pData, flags, pfnCallback)
// pfnThreadProc : LPTHREAD_START_ROUTINE -> "pointer"
// pData : void* optional -> "pointer"
// flags : DWORD -> "u32"
// pfnCallback : LPTHREAD_START_ROUTINE optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SHCreateThread(
    void* pfnThreadProc,
    void* pData,
    uint32_t flags,
    void* pfnCallback);
C, "SHLWAPI.dll");
// $ffi->SHCreateThread(pfnThreadProc, pData, flags, pfnCallback);
// pfnThreadProc : LPTHREAD_START_ROUTINE
// pData : void* optional
// flags : DWORD
// pfnCallback : LPTHREAD_START_ROUTINE optional
// 構造体/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 Shlwapi extends StdCallLibrary {
    Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class);
    boolean SHCreateThread(
        Callback pfnThreadProc,   // LPTHREAD_START_ROUTINE
        Pointer pData,   // void* optional
        int flags,   // DWORD
        Callback pfnCallback   // LPTHREAD_START_ROUTINE optional
    );
}
@[Link("shlwapi")]
lib LibSHLWAPI
  fun SHCreateThread = SHCreateThread(
    pfnThreadProc : Void*,   # LPTHREAD_START_ROUTINE
    pData : Void*,   # void* optional
    flags : UInt32,   # DWORD
    pfnCallback : Void*   # LPTHREAD_START_ROUTINE optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHCreateThreadNative = Int32 Function(Pointer<Void>, Pointer<Void>, Uint32, Pointer<Void>);
typedef SHCreateThreadDart = int Function(Pointer<Void>, Pointer<Void>, int, Pointer<Void>);
final SHCreateThread = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<SHCreateThreadNative, SHCreateThreadDart>('SHCreateThread');
// pfnThreadProc : LPTHREAD_START_ROUTINE -> Pointer<Void>
// pData : void* optional -> Pointer<Void>
// flags : DWORD -> Uint32
// pfnCallback : LPTHREAD_START_ROUTINE optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHCreateThread(
  pfnThreadProc: Pointer;   // LPTHREAD_START_ROUTINE
  pData: Pointer;   // void* optional
  flags: DWORD;   // DWORD
  pfnCallback: Pointer   // LPTHREAD_START_ROUTINE optional
): BOOL; stdcall;
  external 'SHLWAPI.dll' name 'SHCreateThread';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHCreateThread"
  c_SHCreateThread :: Ptr () -> Ptr () -> Word32 -> Ptr () -> IO CInt
-- pfnThreadProc : LPTHREAD_START_ROUTINE -> Ptr ()
-- pData : void* optional -> Ptr ()
-- flags : DWORD -> Word32
-- pfnCallback : LPTHREAD_START_ROUTINE optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shcreatethread =
  foreign "SHCreateThread"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* pfnThreadProc : LPTHREAD_START_ROUTINE -> (ptr void) *)
(* pData : void* optional -> (ptr void) *)
(* flags : DWORD -> uint32_t *)
(* pfnCallback : LPTHREAD_START_ROUTINE optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("SHCreateThread" shcreate-thread :convention :stdcall) :int32
  (pfn-thread-proc :pointer)   ; LPTHREAD_START_ROUTINE
  (p-data :pointer)   ; void* optional
  (flags :uint32)   ; DWORD
  (pfn-callback :pointer))   ; LPTHREAD_START_ROUTINE optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHCreateThread = Win32::API::More->new('SHLWAPI',
    'BOOL SHCreateThread(LPVOID pfnThreadProc, LPVOID pData, DWORD flags, LPVOID pfnCallback)');
# my $ret = $SHCreateThread->Call($pfnThreadProc, $pData, $flags, $pfnCallback);
# pfnThreadProc : LPTHREAD_START_ROUTINE -> LPVOID
# pData : void* optional -> LPVOID
# flags : DWORD -> DWORD
# pfnCallback : LPTHREAD_START_ROUTINE optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

公式の関連項目
使用する型