ホーム › System.Threading › InitOnceExecuteOnce

InitOnceExecuteOnce

関数

指定の初期化関数を一度だけスレッドセーフに実行する。

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

シグネチャ

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

BOOL InitOnceExecuteOnce(
    INIT_ONCE* InitOnce,
    PINIT_ONCE_FN InitFn,
    void* Parameter,   // optional
    void** Context   // optional
);

パラメーター

名前	型	方向	説明
InitOnce	INIT_ONCE*	inout	一回限り初期化構造体へのポインター。
InitFn	PINIT_ONCE_FN	in	アプリケーション定義の InitOnceCallback 関数へのポインター。
Parameter	void*	inoutoptional	コールバック関数に渡すパラメーター。
Context	void**	outoptional	成功時に、一回限り初期化構造体とともに格納されたデータを受け取るパラメーター。データの下位 INIT_ONCE_CTX_RESERVED_BITS ビットは常にゼロです。Context がデータ構造体を指す場合、そのデータ構造体は DWORD 境界に整列している必要があります。Arm32 のコードポインターは常に最下位ビットが設定されているため、Arm32 では Context をコードポインターにしてはなりません。詳細については Arm32 ABI を参照してください。

戻り値の型: BOOL

公式ドキュメント

指定された関数を一度だけ正常に実行します。同じ一回限り初期化構造体を指定する他のスレッドは、現在のスレッドが指定された関数を実行している間、その関数を実行できません。

戻り値

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

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

解説(Remarks)

この関数は同期的な一回限り初期化に使用します。非同期の一回限り初期化には、INIT_ONCE_ASYNC フラグを指定して InitOnceBeginInitialize 関数を使用します。

InitFn で指定されたコールバック関数を実行できるのは、一度に 1 つのスレッドだけです。同じ一回限り初期化構造体を指定する他のスレッドは、コールバックが完了するまでブロックされます。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0600 以降として定義します。詳細については、 Using the Windows Headers を参照してください。

例

この関数を使用する例については、 Using One-Time Initialization を参照してください。

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

各言語での呼び出し定義

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

BOOL InitOnceExecuteOnce(
    INIT_ONCE* InitOnce,
    PINIT_ONCE_FN InitFn,
    void* Parameter,   // optional
    void** Context   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool InitOnceExecuteOnce(
    IntPtr InitOnce,   // INIT_ONCE* in/out
    IntPtr InitFn,   // PINIT_ONCE_FN
    IntPtr Parameter,   // void* optional, in/out
    IntPtr Context   // void** optional, out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function InitOnceExecuteOnce(
    InitOnce As IntPtr,   ' INIT_ONCE* in/out
    InitFn As IntPtr,   ' PINIT_ONCE_FN
    Parameter As IntPtr,   ' void* optional, in/out
    Context As IntPtr   ' void** optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' InitOnce : INIT_ONCE* in/out
' InitFn : PINIT_ONCE_FN
' Parameter : void* optional, in/out
' Context : void** optional, out
Declare PtrSafe Function InitOnceExecuteOnce Lib "kernel32" ( _
    ByVal InitOnce As LongPtr, _
    ByVal InitFn As LongPtr, _
    ByVal Parameter As LongPtr, _
    ByVal Context As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

InitOnceExecuteOnce = ctypes.windll.kernel32.InitOnceExecuteOnce
InitOnceExecuteOnce.restype = wintypes.BOOL
InitOnceExecuteOnce.argtypes = [
    ctypes.c_void_p,  # InitOnce : INIT_ONCE* in/out
    ctypes.c_void_p,  # InitFn : PINIT_ONCE_FN
    ctypes.POINTER(None),  # Parameter : void* optional, in/out
    ctypes.c_void_p,  # Context : void** optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
InitOnceExecuteOnce = Fiddle::Function.new(
  lib['InitOnceExecuteOnce'],
  [
    Fiddle::TYPE_VOIDP,  # InitOnce : INIT_ONCE* in/out
    Fiddle::TYPE_VOIDP,  # InitFn : PINIT_ONCE_FN
    Fiddle::TYPE_VOIDP,  # Parameter : void* optional, in/out
    Fiddle::TYPE_VOIDP,  # Context : void** optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn InitOnceExecuteOnce(
        InitOnce: *mut INIT_ONCE,  // INIT_ONCE* in/out
        InitFn: *const core::ffi::c_void,  // PINIT_ONCE_FN
        Parameter: *mut (),  // void* optional, in/out
        Context: *mut *mut ()  // void** optional, 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 InitOnceExecuteOnce(IntPtr InitOnce, IntPtr InitFn, IntPtr Parameter, IntPtr Context);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_InitOnceExecuteOnce' -Namespace Win32 -PassThru
# $api::InitOnceExecuteOnce(InitOnce, InitFn, Parameter, Context)

#uselib "KERNEL32.dll"
#func global InitOnceExecuteOnce "InitOnceExecuteOnce" sptr, sptr, sptr, sptr
; InitOnceExecuteOnce varptr(InitOnce), InitFn, Parameter, Context   ; 戻り値は stat
; InitOnce : INIT_ONCE* in/out -> "sptr"
; InitFn : PINIT_ONCE_FN -> "sptr"
; Parameter : void* optional, in/out -> "sptr"
; Context : void** optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global InitOnceExecuteOnce "InitOnceExecuteOnce" var, sptr, sptr, sptr
; res = InitOnceExecuteOnce(InitOnce, InitFn, Parameter, Context)
; InitOnce : INIT_ONCE* in/out -> "var"
; InitFn : PINIT_ONCE_FN -> "sptr"
; Parameter : void* optional, in/out -> "sptr"
; Context : void** optional, out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global InitOnceExecuteOnce "InitOnceExecuteOnce" sptr, sptr, sptr, sptr
; res = InitOnceExecuteOnce(varptr(InitOnce), InitFn, Parameter, Context)
; InitOnce : INIT_ONCE* in/out -> "sptr"
; InitFn : PINIT_ONCE_FN -> "sptr"
; Parameter : void* optional, in/out -> "sptr"
; Context : void** optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。