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

FlsAlloc

関数
ファイバーローカルストレージのインデックスを割り当てる。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

DWORD FlsAlloc(
    PFLS_CALLBACK_FUNCTION lpCallback   // optional
);

パラメーター

名前方向説明
lpCallbackPFLS_CALLBACK_FUNCTIONinoptionalPFLS_CALLBACK_FUNCTION 型のアプリケーション定義コールバック関数へのポインターです。このパラメーターは省略可能です。詳細については、 FlsCallback を参照してください。

戻り値の型: DWORD

公式ドキュメント

ファイバーローカルストレージ (FLS) インデックスを割り当てます。

戻り値

関数が成功した場合、戻り値はゼロに初期化された FLS インデックスです。

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

解説(Remarks)

プロセスのファイバーは、この FLS インデックスを以降の FlsFreeFlsSetValue、または FlsGetValue 関数の呼び出しで使用できます。

FLS インデックスは通常、プロセスまたはダイナミックリンクライブラリ (DLL) の初期化時に割り当てられます。FLS インデックスが割り当てられると、プロセスの各ファイバーはそれを使用して独自の FLS ストレージスロットにアクセスできます。FLS スロットに値を格納するには、ファイバーは FlsSetValue の呼び出しでインデックスを指定します。格納した値を取得するには、ファイバーは以降の FlsGetValue の呼び出しで同じインデックスを指定します。

FLS インデックスはプロセスの境界を越えては有効ではありません。DLL は、あるプロセスで割り当てられたインデックスが別のプロセスで有効であると想定することはできません。

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

各言語での呼び出し定義

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

DWORD FlsAlloc(
    PFLS_CALLBACK_FUNCTION lpCallback   // optional
);
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern uint FlsAlloc(
    IntPtr lpCallback   // PFLS_CALLBACK_FUNCTION optional
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FlsAlloc(
    lpCallback As IntPtr   ' PFLS_CALLBACK_FUNCTION optional
) As UInteger
End Function
' lpCallback : PFLS_CALLBACK_FUNCTION optional
Declare PtrSafe Function FlsAlloc Lib "kernel32" ( _
    ByVal lpCallback As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FlsAlloc = ctypes.windll.kernel32.FlsAlloc
FlsAlloc.restype = wintypes.DWORD
FlsAlloc.argtypes = [
    ctypes.c_void_p,  # lpCallback : PFLS_CALLBACK_FUNCTION optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procFlsAlloc = kernel32.NewProc("FlsAlloc")
)

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

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

typedef FlsAllocNative = Uint32 Function(Pointer<Void>);
typedef FlsAllocDart = int Function(Pointer<Void>);
final FlsAlloc = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<FlsAllocNative, FlsAllocDart>('FlsAlloc');
// lpCallback : PFLS_CALLBACK_FUNCTION optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FlsAlloc(
  lpCallback: Pointer   // PFLS_CALLBACK_FUNCTION optional
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'FlsAlloc';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FlsAlloc"
  c_FlsAlloc :: Ptr () -> IO Word32
-- lpCallback : PFLS_CALLBACK_FUNCTION optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let flsalloc =
  foreign "FlsAlloc"
    ((ptr void) @-> returning uint32_t)
(* lpCallback : PFLS_CALLBACK_FUNCTION 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 ("FlsAlloc" fls-alloc :convention :stdcall) :uint32
  (lp-callback :pointer))   ; PFLS_CALLBACK_FUNCTION optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FlsAlloc = Win32::API::More->new('KERNEL32',
    'DWORD FlsAlloc(LPVOID lpCallback)');
# my $ret = $FlsAlloc->Call($lpCallback);
# lpCallback : PFLS_CALLBACK_FUNCTION optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

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