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

AvRtDeleteThreadOrderingGroup

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

シグネチャ

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

BOOL AvRtDeleteThreadOrderingGroup(
    AVRT_THREAD_ORDERING_GROUP_HANDLE Context
);

パラメーター

名前方向説明
ContextAVRT_THREAD_ORDERING_GROUP_HANDLEinコンテキストハンドル。このハンドルは、グループを作成する際に AvRtCreateThreadOrderingGroup 関数によって返されます。

戻り値の型: BOOL

公式ドキュメント

呼び出し元が作成した、指定されたスレッド順序グループを削除します。コンテキスト情報を含むスレッド順序グループのリソースをクリーンアップして戻ります。

戻り値

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

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

解説(Remarks)

この関数を正常に呼び出せるのは、スレッド順序グループの親スレッドのみです。親スレッド以外のスレッドがこの関数を呼び出した場合、関数は失敗し、最終エラーコードは ERROR_INVALID_FUNCTION になります。

親スレッドがタイムアウトした後にこの関数を呼び出そうとした場合、関数は失敗し、最終エラーコードは ERROR_INVALID_PARAMETER になります。

次のコードは、スレッド順序グループを削除します。

#include <windows.h>
#include <avrt.h>
#include <stdio.h>

#pragma comment(lib, "Avrt.lib")

HANDLE Context;

int main( void )
{
    if(!AvRtDeleteThreadOrderingGroup(Context))
    {
        printf("Error deleting group (%d)\n", GetLastError());
        return 1;
    }

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

各言語での呼び出し定義

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

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

AvRtDeleteThreadOrderingGroup = ctypes.windll.avrt.AvRtDeleteThreadOrderingGroup
AvRtDeleteThreadOrderingGroup.restype = wintypes.BOOL
AvRtDeleteThreadOrderingGroup.argtypes = [
    AVRT_THREAD_ORDERING_GROUP_HANDLE,  # Context : AVRT_THREAD_ORDERING_GROUP_HANDLE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('AVRT.dll')
AvRtDeleteThreadOrderingGroup = Fiddle::Function.new(
  lib['AvRtDeleteThreadOrderingGroup'],
  [
    Fiddle::TYPE_VOIDP,  # Context : AVRT_THREAD_ORDERING_GROUP_HANDLE
  ],
  Fiddle::TYPE_INT)
#[link(name = "avrt")]
extern "system" {
    fn AvRtDeleteThreadOrderingGroup(
        Context: AVRT_THREAD_ORDERING_GROUP_HANDLE  // AVRT_THREAD_ORDERING_GROUP_HANDLE
    ) -> 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 AvRtDeleteThreadOrderingGroup(AVRT_THREAD_ORDERING_GROUP_HANDLE Context);
"@
$api = Add-Type -MemberDefinition $sig -Name 'AVRT_AvRtDeleteThreadOrderingGroup' -Namespace Win32 -PassThru
# $api::AvRtDeleteThreadOrderingGroup(Context)
#uselib "AVRT.dll"
#func global AvRtDeleteThreadOrderingGroup "AvRtDeleteThreadOrderingGroup" sptr
; AvRtDeleteThreadOrderingGroup Context   ; 戻り値は stat
; Context : AVRT_THREAD_ORDERING_GROUP_HANDLE -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "AVRT.dll"
#cfunc global AvRtDeleteThreadOrderingGroup "AvRtDeleteThreadOrderingGroup" int
; res = AvRtDeleteThreadOrderingGroup(Context)
; Context : AVRT_THREAD_ORDERING_GROUP_HANDLE -> "int"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; BOOL AvRtDeleteThreadOrderingGroup(AVRT_THREAD_ORDERING_GROUP_HANDLE Context)
#uselib "AVRT.dll"
#cfunc global AvRtDeleteThreadOrderingGroup "AvRtDeleteThreadOrderingGroup" int
; res = AvRtDeleteThreadOrderingGroup(Context)
; Context : AVRT_THREAD_ORDERING_GROUP_HANDLE -> "int"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	avrt = windows.NewLazySystemDLL("AVRT.dll")
	procAvRtDeleteThreadOrderingGroup = avrt.NewProc("AvRtDeleteThreadOrderingGroup")
)

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

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

typedef AvRtDeleteThreadOrderingGroupNative = Int32 Function(AVRT_THREAD_ORDERING_GROUP_HANDLE);
typedef AvRtDeleteThreadOrderingGroupDart = int Function(int);
final AvRtDeleteThreadOrderingGroup = DynamicLibrary.open('AVRT.dll')
    .lookupFunction<AvRtDeleteThreadOrderingGroupNative, AvRtDeleteThreadOrderingGroupDart>('AvRtDeleteThreadOrderingGroup');
// Context : AVRT_THREAD_ORDERING_GROUP_HANDLE -> AVRT_THREAD_ORDERING_GROUP_HANDLE
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function AvRtDeleteThreadOrderingGroup(
  Context: AVRT_THREAD_ORDERING_GROUP_HANDLE   // AVRT_THREAD_ORDERING_GROUP_HANDLE
): BOOL; stdcall;
  external 'AVRT.dll' name 'AvRtDeleteThreadOrderingGroup';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "AvRtDeleteThreadOrderingGroup"
  c_AvRtDeleteThreadOrderingGroup :: AVRT_THREAD_ORDERING_GROUP_HANDLE -> IO CInt
-- Context : AVRT_THREAD_ORDERING_GROUP_HANDLE -> AVRT_THREAD_ORDERING_GROUP_HANDLE
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※値渡し構造体は GHC FFI で直接渡せません。Ptr で渡すラッパ(C側)経由にしてください。
open Ctypes
open Foreign

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

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

関連項目

使用する型