Win32 API 日本語リファレンス
ホームUI.Shell › SHCreateThreadRef

SHCreateThreadRef

関数
スレッド単位の参照カウントオブジェクトを生成する。
DLLSHLWAPI.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT SHCreateThreadRef(
    INT* pcRef,
    IUnknown** ppunk
);

パラメーター

名前方向説明
pcRefINT*inout値へのポインター。通常はスレッドの ThreadProc 内のローカル変数で、ppunk のインターフェイスによって参照カウンターとして使用されます。
ppunkIUnknown**outIUnknown インターフェイスへのポインターのアドレス。成功した場合、このパラメーターは戻り時にスレッドの IUnknown ポインターを保持します。使用が終わったらアプリケーション側でポインターを解放する必要があります。

戻り値の型: HRESULT

公式ドキュメント

スレッドごとの Component Object Model (COM) オブジェクトへの参照を作成します。

戻り値

型: HRESULT

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

Shlwapi のスレッド API の使用方法の詳細については、Managing Thread References を参照してください。

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

各言語での呼び出し定義

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

HRESULT SHCreateThreadRef(
    INT* pcRef,
    IUnknown** ppunk
);
[DllImport("SHLWAPI.dll", ExactSpelling = true)]
static extern int SHCreateThreadRef(
    ref int pcRef,   // INT* in/out
    IntPtr ppunk   // IUnknown** out
);
<DllImport("SHLWAPI.dll", ExactSpelling:=True)>
Public Shared Function SHCreateThreadRef(
    ByRef pcRef As Integer,   ' INT* in/out
    ppunk As IntPtr   ' IUnknown** out
) As Integer
End Function
' pcRef : INT* in/out
' ppunk : IUnknown** out
Declare PtrSafe Function SHCreateThreadRef Lib "shlwapi" ( _
    ByRef pcRef As Long, _
    ByVal ppunk As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHCreateThreadRef = ctypes.windll.shlwapi.SHCreateThreadRef
SHCreateThreadRef.restype = ctypes.c_int
SHCreateThreadRef.argtypes = [
    ctypes.POINTER(ctypes.c_int),  # pcRef : INT* in/out
    ctypes.c_void_p,  # ppunk : IUnknown** out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
SHCreateThreadRef = Fiddle::Function.new(
  lib['SHCreateThreadRef'],
  [
    Fiddle::TYPE_VOIDP,  # pcRef : INT* in/out
    Fiddle::TYPE_VOIDP,  # ppunk : IUnknown** out
  ],
  Fiddle::TYPE_INT)
#[link(name = "shlwapi")]
extern "system" {
    fn SHCreateThreadRef(
        pcRef: *mut i32,  // INT* in/out
        ppunk: *mut *mut core::ffi::c_void  // IUnknown** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll")]
public static extern int SHCreateThreadRef(ref int pcRef, IntPtr ppunk);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_SHCreateThreadRef' -Namespace Win32 -PassThru
# $api::SHCreateThreadRef(pcRef, ppunk)
#uselib "SHLWAPI.dll"
#func global SHCreateThreadRef "SHCreateThreadRef" sptr, sptr
; SHCreateThreadRef varptr(pcRef), ppunk   ; 戻り値は stat
; pcRef : INT* in/out -> "sptr"
; ppunk : IUnknown** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHLWAPI.dll"
#cfunc global SHCreateThreadRef "SHCreateThreadRef" var, sptr
; res = SHCreateThreadRef(pcRef, ppunk)
; pcRef : INT* in/out -> "var"
; ppunk : IUnknown** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT SHCreateThreadRef(INT* pcRef, IUnknown** ppunk)
#uselib "SHLWAPI.dll"
#cfunc global SHCreateThreadRef "SHCreateThreadRef" var, intptr
; res = SHCreateThreadRef(pcRef, ppunk)
; pcRef : INT* in/out -> "var"
; ppunk : IUnknown** out -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procSHCreateThreadRef = shlwapi.NewProc("SHCreateThreadRef")
)

// pcRef (INT* in/out), ppunk (IUnknown** out)
r1, _, err := procSHCreateThreadRef.Call(
	uintptr(pcRef),
	uintptr(ppunk),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function SHCreateThreadRef(
  pcRef: Pointer;   // INT* in/out
  ppunk: Pointer   // IUnknown** out
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'SHCreateThreadRef';
result := DllCall("SHLWAPI\SHCreateThreadRef"
    , "Ptr", pcRef   ; INT* in/out
    , "Ptr", ppunk   ; IUnknown** out
    , "Int")   ; return: HRESULT
●SHCreateThreadRef(pcRef, ppunk) = DLL("SHLWAPI.dll", "int SHCreateThreadRef(void*, void*)")
# 呼び出し: SHCreateThreadRef(pcRef, ppunk)
# pcRef : INT* in/out -> "void*"
# ppunk : IUnknown** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef SHCreateThreadRefNative = Int32 Function(Pointer<Int32>, Pointer<Void>);
typedef SHCreateThreadRefDart = int Function(Pointer<Int32>, Pointer<Void>);
final SHCreateThreadRef = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<SHCreateThreadRefNative, SHCreateThreadRefDart>('SHCreateThreadRef');
// pcRef : INT* in/out -> Pointer<Int32>
// ppunk : IUnknown** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHCreateThreadRef(
  pcRef: Pointer;   // INT* in/out
  ppunk: Pointer   // IUnknown** out
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'SHCreateThreadRef';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHCreateThreadRef"
  c_SHCreateThreadRef :: Ptr Int32 -> Ptr () -> IO Int32
-- pcRef : INT* in/out -> Ptr Int32
-- ppunk : IUnknown** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shcreatethreadref =
  foreign "SHCreateThreadRef"
    ((ptr int32_t) @-> (ptr void) @-> returning int32_t)
(* pcRef : INT* in/out -> (ptr int32_t) *)
(* ppunk : IUnknown** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("SHCreateThreadRef" shcreate-thread-ref :convention :stdcall) :int32
  (pc-ref :pointer)   ; INT* in/out
  (ppunk :pointer))   ; IUnknown** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHCreateThreadRef = Win32::API::More->new('SHLWAPI',
    'int SHCreateThreadRef(LPVOID pcRef, LPVOID ppunk)');
# my $ret = $SHCreateThreadRef->Call($pcRef, $ppunk);
# pcRef : INT* in/out -> LPVOID
# ppunk : IUnknown** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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