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

IUnknown_GetSite

関数
オブジェクトのサイトインターフェイスを取得する。
DLLSHLWAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT IUnknown_GetSite(
    IUnknown* punk,
    const GUID* riid,
    void** ppv
);

パラメーター

名前方向説明
punkIUnknown*inIObjectWithSite::GetSite メソッドを呼び出す対象の COM オブジェクトへのポインターです。
riidGUID*inppvSite に返されるインターフェイスポインターの IID です。
ppvvoid**out要求したインターフェイスポインターを受け取るポインターのアドレスです。関数の呼び出しが成功すると、ppvSite には要求したインターフェイスポインターが格納されます。利用可能なサイトがない場合、または要求したインターフェイスがサポートされていない場合、ppvSiteNULL に設定され、関数は COM エラーコードを返します。

戻り値の型: HRESULT

公式ドキュメント

指定したオブジェクトの IObjectWithSite::GetSite メソッドを呼び出します。

戻り値

型: HRESULT

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

解説(Remarks)

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_GetSite(
    IUnknown* punk,
    const GUID* riid,
    void** ppv
);
[DllImport("SHLWAPI.dll", ExactSpelling = true)]
static extern int IUnknown_GetSite(
    IntPtr punk,   // IUnknown*
    ref Guid riid,   // GUID*
    IntPtr ppv   // void** out
);
<DllImport("SHLWAPI.dll", ExactSpelling:=True)>
Public Shared Function IUnknown_GetSite(
    punk As IntPtr,   ' IUnknown*
    ByRef riid As Guid,   ' GUID*
    ppv As IntPtr   ' void** out
) As Integer
End Function
' punk : IUnknown*
' riid : GUID*
' ppv : void** out
Declare PtrSafe Function IUnknown_GetSite Lib "shlwapi" ( _
    ByVal punk As LongPtr, _
    ByVal riid As LongPtr, _
    ByVal ppv As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

IUnknown_GetSite = ctypes.windll.shlwapi.IUnknown_GetSite
IUnknown_GetSite.restype = ctypes.c_int
IUnknown_GetSite.argtypes = [
    ctypes.c_void_p,  # punk : IUnknown*
    ctypes.c_void_p,  # riid : GUID*
    ctypes.c_void_p,  # ppv : void** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procIUnknown_GetSite = shlwapi.NewProc("IUnknown_GetSite")
)

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

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

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

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

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

関連項目

使用する型