Win32 API 日本語リファレンス
ホームSystem.WinRT › RoGetAgileReference

RoGetAgileReference

関数
オブジェクトへのアジャイル参照を取得する。
DLLOLE32.dll呼出規約winapi対応OSWindows 8.1 以降

シグネチャ

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

HRESULT RoGetAgileReference(
    AgileReferenceOptions options,
    const GUID* riid,
    IUnknown* pUnk,
    IAgileReference** ppAgileReference
);

パラメーター

名前方向説明
optionsAgileReferenceOptionsinアジャイル参照の生成動作を制御するAgileReferenceOptions列挙値。
riidGUID*in参照するオブジェクトのインターフェイスIID(GUID)へのポインタ。
pUnkIUnknown*inアジャイル参照を作成する元オブジェクトのIUnknownポインタ。
ppAgileReferenceIAgileReference**out出力として生成されたIAgileReferenceを受け取るポインタのアドレス。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT RoGetAgileReference(
    AgileReferenceOptions options,
    const GUID* riid,
    IUnknown* pUnk,
    IAgileReference** ppAgileReference
);
[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int RoGetAgileReference(
    int options,   // AgileReferenceOptions
    ref Guid riid,   // GUID*
    IntPtr pUnk,   // IUnknown*
    IntPtr ppAgileReference   // IAgileReference** out
);
<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function RoGetAgileReference(
    options As Integer,   ' AgileReferenceOptions
    ByRef riid As Guid,   ' GUID*
    pUnk As IntPtr,   ' IUnknown*
    ppAgileReference As IntPtr   ' IAgileReference** out
) As Integer
End Function
' options : AgileReferenceOptions
' riid : GUID*
' pUnk : IUnknown*
' ppAgileReference : IAgileReference** out
Declare PtrSafe Function RoGetAgileReference Lib "ole32" ( _
    ByVal options As Long, _
    ByVal riid As LongPtr, _
    ByVal pUnk As LongPtr, _
    ByVal ppAgileReference As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RoGetAgileReference = ctypes.windll.ole32.RoGetAgileReference
RoGetAgileReference.restype = ctypes.c_int
RoGetAgileReference.argtypes = [
    ctypes.c_int,  # options : AgileReferenceOptions
    ctypes.c_void_p,  # riid : GUID*
    ctypes.c_void_p,  # pUnk : IUnknown*
    ctypes.c_void_p,  # ppAgileReference : IAgileReference** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procRoGetAgileReference = ole32.NewProc("RoGetAgileReference")
)

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

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

typedef RoGetAgileReferenceNative = Int32 Function(Int32, Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef RoGetAgileReferenceDart = int Function(int, Pointer<Void>, Pointer<Void>, Pointer<Void>);
final RoGetAgileReference = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<RoGetAgileReferenceNative, RoGetAgileReferenceDart>('RoGetAgileReference');
// options : AgileReferenceOptions -> Int32
// riid : GUID* -> Pointer<Void>
// pUnk : IUnknown* -> Pointer<Void>
// ppAgileReference : IAgileReference** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RoGetAgileReference(
  options: Integer;   // AgileReferenceOptions
  riid: PGUID;   // GUID*
  pUnk: Pointer;   // IUnknown*
  ppAgileReference: Pointer   // IAgileReference** out
): Integer; stdcall;
  external 'OLE32.dll' name 'RoGetAgileReference';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RoGetAgileReference"
  c_RoGetAgileReference :: Int32 -> Ptr () -> Ptr () -> Ptr () -> IO Int32
-- options : AgileReferenceOptions -> Int32
-- riid : GUID* -> Ptr ()
-- pUnk : IUnknown* -> Ptr ()
-- ppAgileReference : IAgileReference** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rogetagilereference =
  foreign "RoGetAgileReference"
    (int32_t @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* options : AgileReferenceOptions -> int32_t *)
(* riid : GUID* -> (ptr void) *)
(* pUnk : IUnknown* -> (ptr void) *)
(* ppAgileReference : IAgileReference** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ole32 (t "OLE32.dll"))
(cffi:use-foreign-library ole32)

(cffi:defcfun ("RoGetAgileReference" ro-get-agile-reference :convention :stdcall) :int32
  (options :int32)   ; AgileReferenceOptions
  (riid :pointer)   ; GUID*
  (p-unk :pointer)   ; IUnknown*
  (pp-agile-reference :pointer))   ; IAgileReference** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RoGetAgileReference = Win32::API::More->new('OLE32',
    'int RoGetAgileReference(int options, LPVOID riid, LPVOID pUnk, LPVOID ppAgileReference)');
# my $ret = $RoGetAgileReference->Call($options, $riid, $pUnk, $ppAgileReference);
# options : AgileReferenceOptions -> int
# riid : GUID* -> LPVOID
# pUnk : IUnknown* -> LPVOID
# ppAgileReference : IAgileReference** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型