ホーム › System.Threading › InitOnceBeginInitialize

InitOnceBeginInitialize

関数

一回限り初期化を開始しその状態を取得する。

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

シグネチャ

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

BOOL InitOnceBeginInitialize(
    INIT_ONCE* lpInitOnce,
    DWORD dwFlags,
    BOOL* fPending,
    void** lpContext   // optional
);

パラメーター

名前

型

方向

説明

lpInitOnce

INIT_ONCE*

inout

1 回限りの初期化構造体へのポインター。

dwFlags

DWORD

このパラメーターには 0、または次のフラグの 1 つ以上を指定できます。

値	意味
INIT_ONCE_ASYNC 0x00000002UL	複数の初期化試行を並列に実行できるようにします。このフラグを使用した場合、以降のこの関数の呼び出しでも同じフラグを指定しないと失敗します。
INIT_ONCE_CHECK_ONLY 0x00000001UL	この関数呼び出しは初期化を開始しません。戻り値は初期化が既に完了しているかどうかを示します。関数が TRUE を返した場合、lpContext パラメーターがデータを受け取ります。

fPending

BOOL*

out

関数が成功した場合、このパラメーターは現在の初期化状態を示します。

このパラメーターが TRUE で、dwFlags に INIT_ONCE_CHECK_ONLY が含まれている場合、初期化は保留中であり、コンテキストデータは無効です。

このパラメーターが FALSE の場合、初期化は既に完了しており、呼び出し元は lpContext パラメーターからコンテキストデータを取得できます。

このパラメーターが TRUE で、dwFlags に INIT_ONCE_CHECK_ONLY が含まれていない場合、初期化が開始されており、呼び出し元は初期化処理を実行できます。

lpContext

void**

outoptional

成功時に、1 回限りの初期化構造体に格納されたデータを受け取る省略可能なパラメーターです。データの下位 INIT_ONCE_CTX_RESERVED_BITS ビットは常にゼロです。

戻り値の型: BOOL

公式ドキュメント

1 回限りの初期化を開始します。

戻り値

INIT_ONCE_CHECK_ONLY が指定されておらず、関数が成功した場合、戻り値は TRUE です。

INIT_ONCE_CHECK_ONLY が指定されており、初期化が完了している場合、戻り値は TRUE です。

それ以外の場合、戻り値は FALSE です。

拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

この関数は、同期または非同期のいずれの 1 回限りの初期化にも使用できます。非同期の 1 回限りの初期化には、INIT_ONCE_ASYNC フラグを使用します。同期の 1 回限りの初期化中に実行するコールバック関数を指定するには、InitOnceExecuteOnce 関数を参照してください。

この関数が成功した場合、スレッドは同期オブジェクトを作成し、InitOnceComplete 関数の lpContext パラメーターに指定できます。

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

1 回限りの初期化オブジェクトは移動またはコピーできません。プロセスは初期化オブジェクトを変更してはならず、論理的に不透明なものとして扱う必要があります。1 回限りの初期化オブジェクトの管理には、1 回限りの初期化関数のみを使用してください。

例

この関数を使用する例については、1 回限りの初期化の使用を参照してください。

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

各言語での呼び出し定義

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

BOOL InitOnceBeginInitialize(
    INIT_ONCE* lpInitOnce,
    DWORD dwFlags,
    BOOL* fPending,
    void** lpContext   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool InitOnceBeginInitialize(
    IntPtr lpInitOnce,   // INIT_ONCE* in/out
    uint dwFlags,   // DWORD
    out bool fPending,   // BOOL* out
    IntPtr lpContext   // void** optional, out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function InitOnceBeginInitialize(
    lpInitOnce As IntPtr,   ' INIT_ONCE* in/out
    dwFlags As UInteger,   ' DWORD
    <Out> ByRef fPending As Boolean,   ' BOOL* out
    lpContext As IntPtr   ' void** optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpInitOnce : INIT_ONCE* in/out
' dwFlags : DWORD
' fPending : BOOL* out
' lpContext : void** optional, out
Declare PtrSafe Function InitOnceBeginInitialize Lib "kernel32" ( _
    ByVal lpInitOnce As LongPtr, _
    ByVal dwFlags As Long, _
    ByRef fPending As Long, _
    ByVal lpContext As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

InitOnceBeginInitialize = ctypes.windll.kernel32.InitOnceBeginInitialize
InitOnceBeginInitialize.restype = wintypes.BOOL
InitOnceBeginInitialize.argtypes = [
    ctypes.c_void_p,  # lpInitOnce : INIT_ONCE* in/out
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # fPending : BOOL* out
    ctypes.c_void_p,  # lpContext : void** optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
InitOnceBeginInitialize = Fiddle::Function.new(
  lib['InitOnceBeginInitialize'],
  [
    Fiddle::TYPE_VOIDP,  # lpInitOnce : INIT_ONCE* in/out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # fPending : BOOL* out
    Fiddle::TYPE_VOIDP,  # lpContext : void** optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn InitOnceBeginInitialize(
        lpInitOnce: *mut INIT_ONCE,  // INIT_ONCE* in/out
        dwFlags: u32,  // DWORD
        fPending: *mut i32,  // BOOL* out
        lpContext: *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 InitOnceBeginInitialize(IntPtr lpInitOnce, uint dwFlags, out bool fPending, IntPtr lpContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_InitOnceBeginInitialize' -Namespace Win32 -PassThru
# $api::InitOnceBeginInitialize(lpInitOnce, dwFlags, fPending, lpContext)

#uselib "KERNEL32.dll"
#func global InitOnceBeginInitialize "InitOnceBeginInitialize" sptr, sptr, sptr, sptr
; InitOnceBeginInitialize varptr(lpInitOnce), dwFlags, varptr(fPending), lpContext   ; 戻り値は stat
; lpInitOnce : INIT_ONCE* in/out -> "sptr"
; dwFlags : DWORD -> "sptr"
; fPending : BOOL* out -> "sptr"
; lpContext : void** optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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