ホーム › System.Threading › InitOnceComplete

InitOnceComplete

関数

一回限り初期化の完了を通知して終了する。

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

シグネチャ

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

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

パラメーター

名前

型

方向

説明

lpInitOnce

INIT_ONCE*

inout

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

dwFlags

DWORD

このパラメーターには、次のいずれかのフラグを指定できます。

値	意味
INIT_ONCE_ASYNC 0x00000002UL	非同期モードで動作します。これにより、複数の完了試行を並列に実行できます。このフラグは、対応する InitOnceBeginInitialize 関数の呼び出しで渡したフラグと一致する必要があります。このフラグは INIT_ONCE_INIT_FAILED と組み合わせることはできません。
INIT_ONCE_INIT_FAILED 0x00000004UL	初期化の試行が失敗しました。このフラグは INIT_ONCE_ASYNC と組み合わせることはできません。非同期初期化を失敗させるには、単にそれを破棄します (つまり、InitOnceComplete 関数を呼び出しません)。

lpContext

void*

inoptional

1 回限りの初期化構造体とともに格納するデータへのポインターです。このデータは、以降の InitOnceBeginInitialize 関数の呼び出しに渡される lpContext パラメーターで返されます。lpContext が値を指している場合、その値の下位 INIT_ONCE_CTX_RESERVED_BITS ビットは 0 でなければなりません。lpContext がデータ構造体を指している場合、そのデータ構造体は DWORD 境界に整列している必要があります。

戻り値の型: BOOL

公式ドキュメント

InitOnceBeginInitialize 関数で開始した 1 回限りの初期化を完了します。

戻り値

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

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

解説(Remarks)

この関数を使用するアプリケーションをコンパイルするには、_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 InitOnceComplete(
    INIT_ONCE* lpInitOnce,
    DWORD dwFlags,
    void* lpContext   // optional
);

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

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

' lpInitOnce : INIT_ONCE* in/out
' dwFlags : DWORD
' lpContext : void* optional
Declare PtrSafe Function InitOnceComplete Lib "kernel32" ( _
    ByVal lpInitOnce As LongPtr, _
    ByVal dwFlags 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

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

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

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