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

IUnknown_SetSite

関数
オブジェクトにサイトポインタを設定する。
DLLSHLWAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT IUnknown_SetSite(
    IUnknown* punk,
    IUnknown* punkSite   // optional
);

パラメーター

名前方向説明
punkIUnknown*inサイトを変更する対象オブジェクトの IUnknown インターフェイスへのポインター。
punkSiteIUnknown*inoptional新しいサイトの IUnknown インターフェイスへのポインター。

戻り値の型: HRESULT

公式ドキュメント

指定したオブジェクトの IObjectWithSite::SetSite メソッドを呼び出して、そのオブジェクトのサイトを設定します。

戻り値

型: HRESULT

サイトの設定に成功した場合は S_OK を返し、それ以外の場合は COM エラーコードを返します。

解説(Remarks)

この関数は、指定したオブジェクトの IUnknown::QueryInterface メソッドを呼び出して、そのオブジェクトの IObjectWithSite インターフェイスへのポインターを取得します。成功した場合、この関数は IObjectWithSite::SetSite を呼び出してサイトを設定または変更します。

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

各言語での呼び出し定義

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

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

IUnknown_SetSite = ctypes.windll.shlwapi.IUnknown_SetSite
IUnknown_SetSite.restype = ctypes.c_int
IUnknown_SetSite.argtypes = [
    ctypes.c_void_p,  # punk : IUnknown*
    ctypes.c_void_p,  # punkSite : IUnknown* optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
IUnknown_SetSite = Fiddle::Function.new(
  lib['IUnknown_SetSite'],
  [
    Fiddle::TYPE_VOIDP,  # punk : IUnknown*
    Fiddle::TYPE_VOIDP,  # punkSite : IUnknown* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "shlwapi")]
extern "system" {
    fn IUnknown_SetSite(
        punk: *mut core::ffi::c_void,  // IUnknown*
        punkSite: *mut core::ffi::c_void  // IUnknown* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll")]
public static extern int IUnknown_SetSite(IntPtr punk, IntPtr punkSite);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_IUnknown_SetSite' -Namespace Win32 -PassThru
# $api::IUnknown_SetSite(punk, punkSite)
#uselib "SHLWAPI.dll"
#func global IUnknown_SetSite "IUnknown_SetSite" sptr, sptr
; IUnknown_SetSite punk, punkSite   ; 戻り値は stat
; punk : IUnknown* -> "sptr"
; punkSite : IUnknown* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHLWAPI.dll"
#cfunc global IUnknown_SetSite "IUnknown_SetSite" sptr, sptr
; res = IUnknown_SetSite(punk, punkSite)
; punk : IUnknown* -> "sptr"
; punkSite : IUnknown* optional -> "sptr"
; HRESULT IUnknown_SetSite(IUnknown* punk, IUnknown* punkSite)
#uselib "SHLWAPI.dll"
#cfunc global IUnknown_SetSite "IUnknown_SetSite" intptr, intptr
; res = IUnknown_SetSite(punk, punkSite)
; punk : IUnknown* -> "intptr"
; punkSite : IUnknown* optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procIUnknown_SetSite = shlwapi.NewProc("IUnknown_SetSite")
)

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

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

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

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

let iunknown_setsite =
  foreign "IUnknown_SetSite"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* punk : IUnknown* -> (ptr void) *)
(* punkSite : 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_SetSite" iunknown-set-site :convention :stdcall) :int32
  (punk :pointer)   ; IUnknown*
  (punk-site :pointer))   ; IUnknown* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $IUnknown_SetSite = Win32::API::More->new('SHLWAPI',
    'int IUnknown_SetSite(LPVOID punk, LPVOID punkSite)');
# my $ret = $IUnknown_SetSite->Call($punk, $punkSite);
# punk : IUnknown* -> LPVOID
# punkSite : IUnknown* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型