Win32 API 日本語リファレンス
ホームSystem.Threading › CreateFiber

CreateFiber

関数
指定の開始ルーチンでファイバーを作成する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

void* CreateFiber(
    UINT_PTR dwStackSize,
    LPFIBER_START_ROUTINE lpStartAddress,
    void* lpParameter   // optional
);

パラメーター

名前方向説明
dwStackSizeUINT_PTRinスタックの初期コミットサイズ(バイト単位)。このパラメーターが 0 の場合、新しいファイバーは実行ファイルの既定のコミットスタックサイズを使用します。詳細については、Thread Stack Size を参照してください。
lpStartAddressLPFIBER_START_ROUTINEinファイバーによって実行されるアプリケーション定義の関数へのポインターであり、ファイバーの開始アドレスを表します。新しく作成されたファイバーの実行は、別のファイバーがこのアドレスを指定して SwitchToFiber 関数を呼び出すまで開始されません。ファイバーコールバック関数の詳細については、 FiberProc を参照してください。
lpParametervoid*inoptionalファイバーに渡される変数へのポインター。ファイバーは GetFiberData マクロを使用してこのデータを取得できます。

戻り値の型: void*

公式ドキュメント

ファイバーオブジェクトを割り当て、それにスタックを割り当て、通常はファイバー関数である指定された開始アドレスから実行を開始するように設定します。この関数はファイバーをスケジュールしません。(CreateFiber)

戻り値

関数が成功した場合、戻り値はファイバーのアドレスです。

関数が失敗した場合、戻り値は NULL です。拡張エラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

プロセスが作成できるファイバーの数は、利用可能な仮想メモリによって制限されます。たとえば、各ファイバーを 1 メガバイトの予約済みスタック領域で作成する場合、最大で 2028 個のファイバーを作成できます。モジュール定義 (.def) ファイル内の STACKSIZE ステートメントを使用するか、 CreateFiberEx を使用して既定のスタックサイズを縮小すると、より多くのファイバーを作成できます。ただし、これほど大量のファイバーを作成する代わりに、要求を処理する別の方法を使用すると、アプリケーションのパフォーマンスが向上します。

スレッドが SwitchToFiber 関数を使用してファイバーをスケジュールするには、その前に ConvertThreadToFiber 関数を呼び出して、スレッドに関連付けられたファイバーが存在するようにする必要があります。

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

例については、Using Fibers を参照してください。

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

各言語での呼び出し定義

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

void* CreateFiber(
    UINT_PTR dwStackSize,
    LPFIBER_START_ROUTINE lpStartAddress,
    void* lpParameter   // optional
);
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr CreateFiber(
    UIntPtr dwStackSize,   // UINT_PTR
    IntPtr lpStartAddress,   // LPFIBER_START_ROUTINE
    IntPtr lpParameter   // void* optional
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateFiber(
    dwStackSize As UIntPtr,   ' UINT_PTR
    lpStartAddress As IntPtr,   ' LPFIBER_START_ROUTINE
    lpParameter As IntPtr   ' void* optional
) As IntPtr
End Function
' dwStackSize : UINT_PTR
' lpStartAddress : LPFIBER_START_ROUTINE
' lpParameter : void* optional
Declare PtrSafe Function CreateFiber Lib "kernel32" ( _
    ByVal dwStackSize As LongPtr, _
    ByVal lpStartAddress As LongPtr, _
    ByVal lpParameter As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CreateFiber = ctypes.windll.kernel32.CreateFiber
CreateFiber.restype = ctypes.c_void_p
CreateFiber.argtypes = [
    ctypes.c_size_t,  # dwStackSize : UINT_PTR
    ctypes.c_void_p,  # lpStartAddress : LPFIBER_START_ROUTINE
    ctypes.POINTER(None),  # lpParameter : void* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
CreateFiber = Fiddle::Function.new(
  lib['CreateFiber'],
  [
    Fiddle::TYPE_UINTPTR_T,  # dwStackSize : UINT_PTR
    Fiddle::TYPE_VOIDP,  # lpStartAddress : LPFIBER_START_ROUTINE
    Fiddle::TYPE_VOIDP,  # lpParameter : void* optional
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "kernel32")]
extern "system" {
    fn CreateFiber(
        dwStackSize: usize,  // UINT_PTR
        lpStartAddress: *const core::ffi::c_void,  // LPFIBER_START_ROUTINE
        lpParameter: *mut ()  // void* optional
    ) -> *mut ();
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern IntPtr CreateFiber(UIntPtr dwStackSize, IntPtr lpStartAddress, IntPtr lpParameter);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CreateFiber' -Namespace Win32 -PassThru
# $api::CreateFiber(dwStackSize, lpStartAddress, lpParameter)
#uselib "KERNEL32.dll"
#func global CreateFiber "CreateFiber" sptr, sptr, sptr
; CreateFiber dwStackSize, lpStartAddress, lpParameter   ; 戻り値は stat
; dwStackSize : UINT_PTR -> "sptr"
; lpStartAddress : LPFIBER_START_ROUTINE -> "sptr"
; lpParameter : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global CreateFiber "CreateFiber" sptr, sptr, sptr
; res = CreateFiber(dwStackSize, lpStartAddress, lpParameter)
; dwStackSize : UINT_PTR -> "sptr"
; lpStartAddress : LPFIBER_START_ROUTINE -> "sptr"
; lpParameter : void* optional -> "sptr"
; void* CreateFiber(UINT_PTR dwStackSize, LPFIBER_START_ROUTINE lpStartAddress, void* lpParameter)
#uselib "KERNEL32.dll"
#cfunc global CreateFiber "CreateFiber" intptr, intptr, intptr
; res = CreateFiber(dwStackSize, lpStartAddress, lpParameter)
; dwStackSize : UINT_PTR -> "intptr"
; lpStartAddress : LPFIBER_START_ROUTINE -> "intptr"
; lpParameter : void* optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCreateFiber = kernel32.NewProc("CreateFiber")
)

// dwStackSize (UINT_PTR), lpStartAddress (LPFIBER_START_ROUTINE), lpParameter (void* optional)
r1, _, err := procCreateFiber.Call(
	uintptr(dwStackSize),
	uintptr(lpStartAddress),
	uintptr(lpParameter),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void*
function CreateFiber(
  dwStackSize: NativeUInt;   // UINT_PTR
  lpStartAddress: Pointer;   // LPFIBER_START_ROUTINE
  lpParameter: Pointer   // void* optional
): Pointer; stdcall;
  external 'KERNEL32.dll' name 'CreateFiber';
result := DllCall("KERNEL32\CreateFiber"
    , "UPtr", dwStackSize   ; UINT_PTR
    , "Ptr", lpStartAddress   ; LPFIBER_START_ROUTINE
    , "Ptr", lpParameter   ; void* optional
    , "Ptr")   ; return: void*
●CreateFiber(dwStackSize, lpStartAddress, lpParameter) = DLL("KERNEL32.dll", "void* CreateFiber(int, void*, void*)")
# 呼び出し: CreateFiber(dwStackSize, lpStartAddress, lpParameter)
# dwStackSize : UINT_PTR -> "int"
# lpStartAddress : LPFIBER_START_ROUTINE -> "void*"
# lpParameter : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef CreateFiberNative = Pointer<Void> Function(UintPtr, Pointer<Void>, Pointer<Void>);
typedef CreateFiberDart = Pointer<Void> Function(int, Pointer<Void>, Pointer<Void>);
final CreateFiber = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<CreateFiberNative, CreateFiberDart>('CreateFiber');
// dwStackSize : UINT_PTR -> UintPtr
// lpStartAddress : LPFIBER_START_ROUTINE -> Pointer<Void>
// lpParameter : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CreateFiber(
  dwStackSize: NativeUInt;   // UINT_PTR
  lpStartAddress: Pointer;   // LPFIBER_START_ROUTINE
  lpParameter: Pointer   // void* optional
): Pointer; stdcall;
  external 'KERNEL32.dll' name 'CreateFiber';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CreateFiber"
  c_CreateFiber :: CUIntPtr -> Ptr () -> Ptr () -> IO (Ptr ())
-- dwStackSize : UINT_PTR -> CUIntPtr
-- lpStartAddress : LPFIBER_START_ROUTINE -> Ptr ()
-- lpParameter : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let createfiber =
  foreign "CreateFiber"
    (size_t @-> (ptr void) @-> (ptr void) @-> returning (ptr void))
(* dwStackSize : UINT_PTR -> size_t *)
(* lpStartAddress : LPFIBER_START_ROUTINE -> (ptr void) *)
(* lpParameter : void* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("CreateFiber" create-fiber :convention :stdcall) :pointer
  (dw-stack-size :uint64)   ; UINT_PTR
  (lp-start-address :pointer)   ; LPFIBER_START_ROUTINE
  (lp-parameter :pointer))   ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CreateFiber = Win32::API::More->new('KERNEL32',
    'LPVOID CreateFiber(WPARAM dwStackSize, LPVOID lpStartAddress, LPVOID lpParameter)');
# my $ret = $CreateFiber->Call($dwStackSize, $lpStartAddress, $lpParameter);
# dwStackSize : UINT_PTR -> WPARAM
# lpStartAddress : LPFIBER_START_ROUTINE -> LPVOID
# lpParameter : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

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