ホーム › System.Threading › AvSetMmThreadCharacteristicsW

AvSetMmThreadCharacteristicsW

関数

マルチメディア処理向けにスレッド特性を登録する(Unicode版)。

DLLAVRT.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// AVRT.dll  (Unicode / -W)
#include <windows.h>

AVRT_TASK_HANDLE AvSetMmThreadCharacteristicsW(
    LPCWSTR TaskName,
    DWORD* TaskIndex
);

パラメーター

名前	型	方向	説明
TaskName	LPCWSTR	in	実行するタスクの名前。この名前は、次のキー HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Multimedia\SystemProfile\Tasks のサブキーのいずれかの名前と一致する必要があります。
TaskIndex	DWORD*	inout	一意のタスク識別子。この関数を初めて呼び出すときは、入力時にこの値を 0 にする必要があります。インデックス値は出力として返され、以降の呼び出しで入力として使用できます。

戻り値の型: AVRT_TASK_HANDLE

公式ドキュメント

呼び出し元スレッドを指定されたタスクに関連付けます。(Unicode)

戻り値

関数が成功した場合、タスクへのハンドルを返します。

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

発生し得るエラーコードは次のとおりです。

戻り値	説明
ERROR_INVALID_TASK_INDEX	TaskIndex が最初の呼び出しで 0 でないか、または(以降の呼び出しで)認識されない値です。
ERROR_INVALID_TASK_NAME	指定されたタスクが、レジストリに格納されているいずれのタスクとも一致しません。
ERROR_PRIVILEGE_NOT_HELD	呼び出し元に十分な特権がありません。

解説(Remarks)

タスクが完了したら、AvRevertMmThreadCharacteristics 関数を呼び出します。

メモ

avrt.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして AvSetMmThreadCharacteristics を定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させて使用すると、不一致が生じてコンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規約を参照してください。

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

各言語での呼び出し定義

// AVRT.dll  (Unicode / -W)
#include <windows.h>

AVRT_TASK_HANDLE AvSetMmThreadCharacteristicsW(
    LPCWSTR TaskName,
    DWORD* TaskIndex
);

[DllImport("AVRT.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern AVRT_TASK_HANDLE AvSetMmThreadCharacteristicsW(
    [MarshalAs(UnmanagedType.LPWStr)] string TaskName,   // LPCWSTR
    ref uint TaskIndex   // DWORD* in/out
);

<DllImport("AVRT.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function AvSetMmThreadCharacteristicsW(
    <MarshalAs(UnmanagedType.LPWStr)> TaskName As String,   ' LPCWSTR
    ByRef TaskIndex As UInteger   ' DWORD* in/out
) As AVRT_TASK_HANDLE
End Function

' TaskName : LPCWSTR
' TaskIndex : DWORD* in/out
Declare PtrSafe Function AvSetMmThreadCharacteristicsW Lib "avrt" ( _
    ByVal TaskName As LongPtr, _
    ByRef TaskIndex As Long) As LongPtr
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

AvSetMmThreadCharacteristicsW = ctypes.windll.avrt.AvSetMmThreadCharacteristicsW
AvSetMmThreadCharacteristicsW.restype = ctypes.c_void_p
AvSetMmThreadCharacteristicsW.argtypes = [
    wintypes.LPCWSTR,  # TaskName : LPCWSTR
    ctypes.POINTER(wintypes.DWORD),  # TaskIndex : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('AVRT.dll')
AvSetMmThreadCharacteristicsW = Fiddle::Function.new(
  lib['AvSetMmThreadCharacteristicsW'],
  [
    Fiddle::TYPE_VOIDP,  # TaskName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # TaskIndex : DWORD* in/out
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "avrt")]
extern "system" {
    fn AvSetMmThreadCharacteristicsW(
        TaskName: *const u16,  // LPCWSTR
        TaskIndex: *mut u32  // DWORD* in/out
    ) -> AVRT_TASK_HANDLE;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("AVRT.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern AVRT_TASK_HANDLE AvSetMmThreadCharacteristicsW([MarshalAs(UnmanagedType.LPWStr)] string TaskName, ref uint TaskIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'AVRT_AvSetMmThreadCharacteristicsW' -Namespace Win32 -PassThru
# $api::AvSetMmThreadCharacteristicsW(TaskName, TaskIndex)

#uselib "AVRT.dll"
#func global AvSetMmThreadCharacteristicsW "AvSetMmThreadCharacteristicsW" wptr, wptr
; AvSetMmThreadCharacteristicsW TaskName, varptr(TaskIndex)   ; 戻り値は stat
; TaskName : LPCWSTR -> "wptr"
; TaskIndex : DWORD* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "AVRT.dll"
#cfunc global AvSetMmThreadCharacteristicsW "AvSetMmThreadCharacteristicsW" wstr, var
; res = AvSetMmThreadCharacteristicsW(TaskName, TaskIndex)
; TaskName : LPCWSTR -> "wstr"
; TaskIndex : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "AVRT.dll"
#cfunc global AvSetMmThreadCharacteristicsW "AvSetMmThreadCharacteristicsW" wstr, sptr
; res = AvSetMmThreadCharacteristicsW(TaskName, varptr(TaskIndex))
; TaskName : LPCWSTR -> "wstr"
; TaskIndex : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。