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

IUnknown_Set

関数
保持中のインターフェイスポインタを安全に差し替える。
DLLSHLWAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

void IUnknown_Set(
    IUnknown** ppunk,
    IUnknown* punk   // optional
);

パラメーター

名前方向説明
ppunkIUnknown**inoutpunk に割り当てられたポインターを受け取る COM インターフェイス ポインターのアドレス。ポインターの以前の値が NULL 以外の場合、この関数は IUnkown::Release メソッドを呼び出してそのインターフェイスを解放します。
punkIUnknown*inoptionalppunk にコピーされるインターフェイス ポインター。値が NULL 以外の場合、この関数はインターフェイスの参照カウントをインクリメントします。

戻り値の型: void

公式ドキュメント

Component Object Model (COM) インターフェイス ポインターの値を変更し、以前のインターフェイスを解放します。

解説(Remarks)

この関数はスマート ポインターの動作を模倣します。概念的には、この関数は次の処理を行います。


void sample()
{
  IUnknown *punk = NULL;
  IStream* pstm = NULL;

  if (SUCCEEDED(CreateStreamOnHGlobal(NULL, TRUE, &pstm)) {
    // since punk == NULL, this merely copies the value and AddRef()s it
    IUnknown_Set(&punk, pstm);
    pstm->Release();

    if (SUCCEEDED(CreateStreamOnHGlobal(NULL, TRUE, &pstm)) {
      // this call will release the old value of punk before copying the
      // new value and AddRef()ing it
      IUnknown_Set(&punk, pstm);
      pstm->Release();
    }
  }

  // This call will release whatever punk points to, if anything.
  IUnknown_AtomcRelease((void**)&punk);

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

各言語での呼び出し定義

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

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

IUnknown_Set = ctypes.windll.shlwapi.IUnknown_Set
IUnknown_Set.restype = None
IUnknown_Set.argtypes = [
    ctypes.c_void_p,  # ppunk : IUnknown** in/out
    ctypes.c_void_p,  # punk : IUnknown* optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
IUnknown_Set = Fiddle::Function.new(
  lib['IUnknown_Set'],
  [
    Fiddle::TYPE_VOIDP,  # ppunk : IUnknown** in/out
    Fiddle::TYPE_VOIDP,  # punk : IUnknown* optional
  ],
  Fiddle::TYPE_VOID)
#[link(name = "shlwapi")]
extern "system" {
    fn IUnknown_Set(
        ppunk: *mut *mut core::ffi::c_void,  // IUnknown** in/out
        punk: *mut core::ffi::c_void  // IUnknown* optional
    );
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll")]
public static extern void IUnknown_Set(IntPtr ppunk, IntPtr punk);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_IUnknown_Set' -Namespace Win32 -PassThru
# $api::IUnknown_Set(ppunk, punk)
#uselib "SHLWAPI.dll"
#func global IUnknown_Set "IUnknown_Set" sptr, sptr
; IUnknown_Set ppunk, punk
; ppunk : IUnknown** in/out -> "sptr"
; punk : IUnknown* optional -> "sptr"
#uselib "SHLWAPI.dll"
#func global IUnknown_Set "IUnknown_Set" sptr, sptr
; IUnknown_Set ppunk, punk
; ppunk : IUnknown** in/out -> "sptr"
; punk : IUnknown* optional -> "sptr"
; void IUnknown_Set(IUnknown** ppunk, IUnknown* punk)
#uselib "SHLWAPI.dll"
#func global IUnknown_Set "IUnknown_Set" intptr, intptr
; IUnknown_Set ppunk, punk
; ppunk : IUnknown** in/out -> "intptr"
; punk : IUnknown* optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procIUnknown_Set = shlwapi.NewProc("IUnknown_Set")
)

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

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

typedef IUnknown_SetNative = Void Function(Pointer<Void>, Pointer<Void>);
typedef IUnknown_SetDart = void Function(Pointer<Void>, Pointer<Void>);
final IUnknown_Set = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<IUnknown_SetNative, IUnknown_SetDart>('IUnknown_Set');
// ppunk : IUnknown** in/out -> Pointer<Void>
// punk : IUnknown* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
procedure IUnknown_Set(
  ppunk: Pointer;   // IUnknown** in/out
  punk: Pointer   // IUnknown* optional
); stdcall;
  external 'SHLWAPI.dll' name 'IUnknown_Set';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

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

関連項目

使用する型