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

AvRtJoinThreadOrderingGroup

関数
スレッド順序付けグループに参加する。
DLLAVRT.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL AvRtJoinThreadOrderingGroup(
    AVRT_THREAD_ORDERING_GROUP_HANDLE* Context,
    GUID* ThreadOrderingGuid,
    BOOL Before
);

パラメーター

名前方向説明
ContextAVRT_THREAD_ORDERING_GROUP_HANDLE*outコンテキストハンドルへのポインター。
ThreadOrderingGuidGUID*inスレッド順序グループの一意な識別子へのポインター。
BeforeBOOLinスレッドの順序。このパラメーターが TRUE の場合、スレッドは親スレッドより前に実行されるようにスケジュールされる先行スレッドです。このパラメーターが FALSE の場合、スレッドは親スレッドより後に実行されるようにスケジュールされる後続スレッドです。

戻り値の型: BOOL

公式ドキュメント

クライアントスレッドをスレッド順序グループに参加させます。

戻り値

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

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

解説(Remarks)

スレッドは、AvRtWaitOnThreadOrderingGroup 関数によって制御されるループ内の各周期の間に実行されるコードを囲みます。

スレッドは複数のスレッド順序グループを作成でき、複数のスレッド順序グループに参加できます。ただし、スレッドは同じスレッド順序グループに複数回参加することはできません。

グループに参加できるスレッドの数は、利用可能なシステムリソースによってのみ制限されます。

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

各言語での呼び出し定義

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

BOOL AvRtJoinThreadOrderingGroup(
    AVRT_THREAD_ORDERING_GROUP_HANDLE* Context,
    GUID* ThreadOrderingGuid,
    BOOL Before
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("AVRT.dll", SetLastError = true, ExactSpelling = true)]
static extern bool AvRtJoinThreadOrderingGroup(
    IntPtr Context,   // AVRT_THREAD_ORDERING_GROUP_HANDLE* out
    ref Guid ThreadOrderingGuid,   // GUID*
    bool Before   // BOOL
);
<DllImport("AVRT.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function AvRtJoinThreadOrderingGroup(
    Context As IntPtr,   ' AVRT_THREAD_ORDERING_GROUP_HANDLE* out
    ByRef ThreadOrderingGuid As Guid,   ' GUID*
    Before As Boolean   ' BOOL
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' Context : AVRT_THREAD_ORDERING_GROUP_HANDLE* out
' ThreadOrderingGuid : GUID*
' Before : BOOL
Declare PtrSafe Function AvRtJoinThreadOrderingGroup Lib "avrt" ( _
    ByVal Context As LongPtr, _
    ByVal ThreadOrderingGuid As LongPtr, _
    ByVal Before As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

AvRtJoinThreadOrderingGroup = ctypes.windll.avrt.AvRtJoinThreadOrderingGroup
AvRtJoinThreadOrderingGroup.restype = wintypes.BOOL
AvRtJoinThreadOrderingGroup.argtypes = [
    ctypes.c_void_p,  # Context : AVRT_THREAD_ORDERING_GROUP_HANDLE* out
    ctypes.c_void_p,  # ThreadOrderingGuid : GUID*
    wintypes.BOOL,  # Before : BOOL
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('AVRT.dll')
AvRtJoinThreadOrderingGroup = Fiddle::Function.new(
  lib['AvRtJoinThreadOrderingGroup'],
  [
    Fiddle::TYPE_VOIDP,  # Context : AVRT_THREAD_ORDERING_GROUP_HANDLE* out
    Fiddle::TYPE_VOIDP,  # ThreadOrderingGuid : GUID*
    Fiddle::TYPE_INT,  # Before : BOOL
  ],
  Fiddle::TYPE_INT)
#[link(name = "avrt")]
extern "system" {
    fn AvRtJoinThreadOrderingGroup(
        Context: *mut AVRT_THREAD_ORDERING_GROUP_HANDLE,  // AVRT_THREAD_ORDERING_GROUP_HANDLE* out
        ThreadOrderingGuid: *mut GUID,  // GUID*
        Before: i32  // BOOL
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("AVRT.dll", SetLastError = true)]
public static extern bool AvRtJoinThreadOrderingGroup(IntPtr Context, ref Guid ThreadOrderingGuid, bool Before);
"@
$api = Add-Type -MemberDefinition $sig -Name 'AVRT_AvRtJoinThreadOrderingGroup' -Namespace Win32 -PassThru
# $api::AvRtJoinThreadOrderingGroup(Context, ThreadOrderingGuid, Before)
#uselib "AVRT.dll"
#func global AvRtJoinThreadOrderingGroup "AvRtJoinThreadOrderingGroup" sptr, sptr, sptr
; AvRtJoinThreadOrderingGroup varptr(Context), varptr(ThreadOrderingGuid), Before   ; 戻り値は stat
; Context : AVRT_THREAD_ORDERING_GROUP_HANDLE* out -> "sptr"
; ThreadOrderingGuid : GUID* -> "sptr"
; Before : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "AVRT.dll"
#cfunc global AvRtJoinThreadOrderingGroup "AvRtJoinThreadOrderingGroup" var, var, int
; res = AvRtJoinThreadOrderingGroup(Context, ThreadOrderingGuid, Before)
; Context : AVRT_THREAD_ORDERING_GROUP_HANDLE* out -> "var"
; ThreadOrderingGuid : GUID* -> "var"
; Before : BOOL -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL AvRtJoinThreadOrderingGroup(AVRT_THREAD_ORDERING_GROUP_HANDLE* Context, GUID* ThreadOrderingGuid, BOOL Before)
#uselib "AVRT.dll"
#cfunc global AvRtJoinThreadOrderingGroup "AvRtJoinThreadOrderingGroup" var, var, int
; res = AvRtJoinThreadOrderingGroup(Context, ThreadOrderingGuid, Before)
; Context : AVRT_THREAD_ORDERING_GROUP_HANDLE* out -> "var"
; ThreadOrderingGuid : GUID* -> "var"
; Before : BOOL -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	avrt = windows.NewLazySystemDLL("AVRT.dll")
	procAvRtJoinThreadOrderingGroup = avrt.NewProc("AvRtJoinThreadOrderingGroup")
)

// Context (AVRT_THREAD_ORDERING_GROUP_HANDLE* out), ThreadOrderingGuid (GUID*), Before (BOOL)
r1, _, err := procAvRtJoinThreadOrderingGroup.Call(
	uintptr(Context),
	uintptr(ThreadOrderingGuid),
	uintptr(Before),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function AvRtJoinThreadOrderingGroup(
  Context: Pointer;   // AVRT_THREAD_ORDERING_GROUP_HANDLE* out
  ThreadOrderingGuid: PGUID;   // GUID*
  Before: BOOL   // BOOL
): BOOL; stdcall;
  external 'AVRT.dll' name 'AvRtJoinThreadOrderingGroup';
result := DllCall("AVRT\AvRtJoinThreadOrderingGroup"
    , "Ptr", Context   ; AVRT_THREAD_ORDERING_GROUP_HANDLE* out
    , "Ptr", ThreadOrderingGuid   ; GUID*
    , "Int", Before   ; BOOL
    , "Int")   ; return: BOOL
●AvRtJoinThreadOrderingGroup(Context, ThreadOrderingGuid, Before) = DLL("AVRT.dll", "bool AvRtJoinThreadOrderingGroup(void*, void*, bool)")
# 呼び出し: AvRtJoinThreadOrderingGroup(Context, ThreadOrderingGuid, Before)
# Context : AVRT_THREAD_ORDERING_GROUP_HANDLE* out -> "void*"
# ThreadOrderingGuid : GUID* -> "void*"
# Before : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "avrt" fn AvRtJoinThreadOrderingGroup(
    Context: [*c]AVRT_THREAD_ORDERING_GROUP_HANDLE, // AVRT_THREAD_ORDERING_GROUP_HANDLE* out
    ThreadOrderingGuid: [*c]GUID, // GUID*
    Before: i32 // BOOL
) callconv(std.os.windows.WINAPI) i32;
proc AvRtJoinThreadOrderingGroup(
    Context: ptr AVRT_THREAD_ORDERING_GROUP_HANDLE,  # AVRT_THREAD_ORDERING_GROUP_HANDLE* out
    ThreadOrderingGuid: ptr GUID,  # GUID*
    Before: int32  # BOOL
): int32 {.importc: "AvRtJoinThreadOrderingGroup", stdcall, dynlib: "AVRT.dll".}
pragma(lib, "avrt");
extern(Windows)
int AvRtJoinThreadOrderingGroup(
    AVRT_THREAD_ORDERING_GROUP_HANDLE* Context,   // AVRT_THREAD_ORDERING_GROUP_HANDLE* out
    GUID* ThreadOrderingGuid,   // GUID*
    int Before   // BOOL
);
ccall((:AvRtJoinThreadOrderingGroup, "AVRT.dll"), stdcall, Int32,
      (Ptr{AVRT_THREAD_ORDERING_GROUP_HANDLE}, Ptr{GUID}, Int32),
      Context, ThreadOrderingGuid, Before)
# Context : AVRT_THREAD_ORDERING_GROUP_HANDLE* out -> Ptr{AVRT_THREAD_ORDERING_GROUP_HANDLE}
# ThreadOrderingGuid : GUID* -> Ptr{GUID}
# Before : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t AvRtJoinThreadOrderingGroup(
    void* Context,
    void* ThreadOrderingGuid,
    int32_t Before);
]]
local avrt = ffi.load("avrt")
-- avrt.AvRtJoinThreadOrderingGroup(Context, ThreadOrderingGuid, Before)
-- Context : AVRT_THREAD_ORDERING_GROUP_HANDLE* out
-- ThreadOrderingGuid : GUID*
-- Before : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('AVRT.dll');
const AvRtJoinThreadOrderingGroup = lib.func('__stdcall', 'AvRtJoinThreadOrderingGroup', 'int32_t', ['void *', 'void *', 'int32_t']);
// AvRtJoinThreadOrderingGroup(Context, ThreadOrderingGuid, Before)
// Context : AVRT_THREAD_ORDERING_GROUP_HANDLE* out -> 'void *'
// ThreadOrderingGuid : GUID* -> 'void *'
// Before : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("AVRT.dll", {
  AvRtJoinThreadOrderingGroup: { parameters: ["pointer", "pointer", "i32"], result: "i32" },
});
// lib.symbols.AvRtJoinThreadOrderingGroup(Context, ThreadOrderingGuid, Before)
// Context : AVRT_THREAD_ORDERING_GROUP_HANDLE* out -> "pointer"
// ThreadOrderingGuid : GUID* -> "pointer"
// Before : BOOL -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t AvRtJoinThreadOrderingGroup(
    void* Context,
    void* ThreadOrderingGuid,
    int32_t Before);
C, "AVRT.dll");
// $ffi->AvRtJoinThreadOrderingGroup(Context, ThreadOrderingGuid, Before);
// Context : AVRT_THREAD_ORDERING_GROUP_HANDLE* out
// ThreadOrderingGuid : GUID*
// Before : BOOL
// 構造体/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 Avrt extends StdCallLibrary {
    Avrt INSTANCE = Native.load("avrt", Avrt.class);
    boolean AvRtJoinThreadOrderingGroup(
        Pointer Context,   // AVRT_THREAD_ORDERING_GROUP_HANDLE* out
        Pointer ThreadOrderingGuid,   // GUID*
        boolean Before   // BOOL
    );
}
@[Link("avrt")]
lib LibAVRT
  fun AvRtJoinThreadOrderingGroup = AvRtJoinThreadOrderingGroup(
    Context : AVRT_THREAD_ORDERING_GROUP_HANDLE*,   # AVRT_THREAD_ORDERING_GROUP_HANDLE* out
    ThreadOrderingGuid : GUID*,   # GUID*
    Before : Int32   # BOOL
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef AvRtJoinThreadOrderingGroupNative = Int32 Function(Pointer<Void>, Pointer<Void>, Int32);
typedef AvRtJoinThreadOrderingGroupDart = int Function(Pointer<Void>, Pointer<Void>, int);
final AvRtJoinThreadOrderingGroup = DynamicLibrary.open('AVRT.dll')
    .lookupFunction<AvRtJoinThreadOrderingGroupNative, AvRtJoinThreadOrderingGroupDart>('AvRtJoinThreadOrderingGroup');
// Context : AVRT_THREAD_ORDERING_GROUP_HANDLE* out -> Pointer<Void>
// ThreadOrderingGuid : GUID* -> Pointer<Void>
// Before : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function AvRtJoinThreadOrderingGroup(
  Context: Pointer;   // AVRT_THREAD_ORDERING_GROUP_HANDLE* out
  ThreadOrderingGuid: PGUID;   // GUID*
  Before: BOOL   // BOOL
): BOOL; stdcall;
  external 'AVRT.dll' name 'AvRtJoinThreadOrderingGroup';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "AvRtJoinThreadOrderingGroup"
  c_AvRtJoinThreadOrderingGroup :: Ptr () -> Ptr () -> CInt -> IO CInt
-- Context : AVRT_THREAD_ORDERING_GROUP_HANDLE* out -> Ptr ()
-- ThreadOrderingGuid : GUID* -> Ptr ()
-- Before : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let avrtjointhreadorderinggroup =
  foreign "AvRtJoinThreadOrderingGroup"
    ((ptr void) @-> (ptr void) @-> int32_t @-> returning int32_t)
(* Context : AVRT_THREAD_ORDERING_GROUP_HANDLE* out -> (ptr void) *)
(* ThreadOrderingGuid : GUID* -> (ptr void) *)
(* Before : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library avrt (t "AVRT.dll"))
(cffi:use-foreign-library avrt)

(cffi:defcfun ("AvRtJoinThreadOrderingGroup" av-rt-join-thread-ordering-group :convention :stdcall) :int32
  (context :pointer)   ; AVRT_THREAD_ORDERING_GROUP_HANDLE* out
  (thread-ordering-guid :pointer)   ; GUID*
  (before :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $AvRtJoinThreadOrderingGroup = Win32::API::More->new('AVRT',
    'BOOL AvRtJoinThreadOrderingGroup(LPVOID Context, LPVOID ThreadOrderingGuid, BOOL Before)');
# my $ret = $AvRtJoinThreadOrderingGroup->Call($Context, $ThreadOrderingGuid, $Before);
# Context : AVRT_THREAD_ORDERING_GROUP_HANDLE* out -> LPVOID
# ThreadOrderingGuid : GUID* -> LPVOID
# Before : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型