ホーム › System.Threading › InitializeProcThreadAttributeList

InitializeProcThreadAttributeList

関数

プロセス/スレッド属性リストを初期化する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL InitializeProcThreadAttributeList(
    LPPROC_THREAD_ATTRIBUTE_LIST lpAttributeList,   // optional
    DWORD dwAttributeCount,
    DWORD dwFlags,   // optional
    UINT_PTR* lpSize
);

パラメーター

名前	型	方向	説明
lpAttributeList	LPPROC_THREAD_ATTRIBUTE_LIST	outoptional	属性リスト。このパラメーターには NULL を指定でき、指定された数の属性をサポートするために必要なバッファーサイズを取得するために使用できます。
dwAttributeCount	DWORD	in	リストに追加する属性の数。
dwFlags	DWORD	optional	このパラメーターは予約されており、0 を指定する必要があります。
lpSize	UINT_PTR*	inout	lpAttributeList が NULL でない場合、このパラメーターは入力時に lpAttributeList バッファーのサイズ(バイト単位)を指定します。出力時には、初期化された属性リストのサイズ(バイト単位)を受け取ります。 lpAttributeList が NULL の場合、このパラメーターは必要なバッファーサイズ(バイト単位)を受け取ります。

戻り値の型: BOOL

公式ドキュメント

プロセスおよびスレッドの作成に使用する、指定された属性リストを初期化します。

戻り値

関数が成功した場合、戻り値は 0 以外の値になります。

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

解説(Remarks)

まず、dwAttributeCount パラメーターに使用する属性の最大数を設定し、lpAttributeList を NULL にしてこの関数を呼び出します。関数は必要なバッファーサイズ(バイト単位)を lpSize パラメーターに返します。

注この最初の呼び出しは、仕様によりエラーを返します。これは想定された動作です。

lpAttributeList バッファーにデータを格納するための十分な領域を割り当て、もう一度この関数を呼び出してバッファーを初期化します。

属性をリストに追加するには、UpdateProcThreadAttribute 関数を呼び出します。プロセスの作成時にこれらの属性を指定するには、dwCreationFlag パラメーターに EXTENDED_STARTUPINFO_PRESENT を指定し、lpStartupInfo パラメーターに STARTUPINFOEX 構造体を指定します。なお、同じ STARTUPINFOEX 構造体を複数の子プロセスに指定できます。

リストの使用が終わったら、DeleteProcThreadAttributeList 関数を呼び出します。

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

各言語での呼び出し定義

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

BOOL InitializeProcThreadAttributeList(
    LPPROC_THREAD_ATTRIBUTE_LIST lpAttributeList,   // optional
    DWORD dwAttributeCount,
    DWORD dwFlags,   // optional
    UINT_PTR* lpSize
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool InitializeProcThreadAttributeList(
    IntPtr lpAttributeList,   // LPPROC_THREAD_ATTRIBUTE_LIST optional, out
    uint dwAttributeCount,   // DWORD
    uint dwFlags,   // DWORD optional
    ref UIntPtr lpSize   // UINT_PTR* in/out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function InitializeProcThreadAttributeList(
    lpAttributeList As IntPtr,   ' LPPROC_THREAD_ATTRIBUTE_LIST optional, out
    dwAttributeCount As UInteger,   ' DWORD
    dwFlags As UInteger,   ' DWORD optional
    ByRef lpSize As UIntPtr   ' UINT_PTR* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpAttributeList : LPPROC_THREAD_ATTRIBUTE_LIST optional, out
' dwAttributeCount : DWORD
' dwFlags : DWORD optional
' lpSize : UINT_PTR* in/out
Declare PtrSafe Function InitializeProcThreadAttributeList Lib "kernel32" ( _
    ByVal lpAttributeList As LongPtr, _
    ByVal dwAttributeCount As Long, _
    ByVal dwFlags As Long, _
    ByRef lpSize As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

InitializeProcThreadAttributeList = ctypes.windll.kernel32.InitializeProcThreadAttributeList
InitializeProcThreadAttributeList.restype = wintypes.BOOL
InitializeProcThreadAttributeList.argtypes = [
    wintypes.HANDLE,  # lpAttributeList : LPPROC_THREAD_ATTRIBUTE_LIST optional, out
    wintypes.DWORD,  # dwAttributeCount : DWORD
    wintypes.DWORD,  # dwFlags : DWORD optional
    ctypes.POINTER(ctypes.c_size_t),  # lpSize : UINT_PTR* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
InitializeProcThreadAttributeList = Fiddle::Function.new(
  lib['InitializeProcThreadAttributeList'],
  [
    Fiddle::TYPE_VOIDP,  # lpAttributeList : LPPROC_THREAD_ATTRIBUTE_LIST optional, out
    -Fiddle::TYPE_INT,  # dwAttributeCount : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : DWORD optional
    Fiddle::TYPE_VOIDP,  # lpSize : UINT_PTR* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn InitializeProcThreadAttributeList(
        lpAttributeList: *mut core::ffi::c_void,  // LPPROC_THREAD_ATTRIBUTE_LIST optional, out
        dwAttributeCount: u32,  // DWORD
        dwFlags: u32,  // DWORD optional
        lpSize: *mut usize  // UINT_PTR* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool InitializeProcThreadAttributeList(IntPtr lpAttributeList, uint dwAttributeCount, uint dwFlags, ref UIntPtr lpSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_InitializeProcThreadAttributeList' -Namespace Win32 -PassThru
# $api::InitializeProcThreadAttributeList(lpAttributeList, dwAttributeCount, dwFlags, lpSize)

#uselib "KERNEL32.dll"
#func global InitializeProcThreadAttributeList "InitializeProcThreadAttributeList" sptr, sptr, sptr, sptr
; InitializeProcThreadAttributeList lpAttributeList, dwAttributeCount, dwFlags, varptr(lpSize)   ; 戻り値は stat
; lpAttributeList : LPPROC_THREAD_ATTRIBUTE_LIST optional, out -> "sptr"
; dwAttributeCount : DWORD -> "sptr"
; dwFlags : DWORD optional -> "sptr"
; lpSize : UINT_PTR* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global InitializeProcThreadAttributeList "InitializeProcThreadAttributeList" sptr, int, int, var
; res = InitializeProcThreadAttributeList(lpAttributeList, dwAttributeCount, dwFlags, lpSize)
; lpAttributeList : LPPROC_THREAD_ATTRIBUTE_LIST optional, out -> "sptr"
; dwAttributeCount : DWORD -> "int"
; dwFlags : DWORD optional -> "int"
; lpSize : UINT_PTR* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global InitializeProcThreadAttributeList "InitializeProcThreadAttributeList" sptr, int, int, sptr
; res = InitializeProcThreadAttributeList(lpAttributeList, dwAttributeCount, dwFlags, varptr(lpSize))
; lpAttributeList : LPPROC_THREAD_ATTRIBUTE_LIST optional, out -> "sptr"
; dwAttributeCount : DWORD -> "int"
; dwFlags : DWORD optional -> "int"
; lpSize : UINT_PTR* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。