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

MonikerRelativePathTo

関数
二つのモニカー間の相対パスモニカーを生成する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT MonikerRelativePathTo(
    IMoniker* pmkSrc,
    IMoniker* pmkDest,
    IMoniker** ppmkRelPath,
    BOOL dwReserved
);

パラメーター

名前方向説明
pmkSrcIMoniker*in作成する相対モニカーと合成すると pmkDest を生成するモニカー上の IMoniker インターフェイスへのポインター。このモニカーは、作成する相対モニカーの「ソース」を識別します。
pmkDestIMoniker*inpmkSrc からの相対として表現するモニカー上の IMoniker インターフェイスへのポインター。このモニカーは、作成する相対モニカーの宛先を識別します。
ppmkRelPathIMoniker**out新しい相対モニカーへのインターフェイスポインターを受け取る IMoniker* ポインター変数のアドレス。成功した場合、この関数はモニカーに対して AddRef を呼び出しており、呼び出し側が Release を呼び出す責任を負います。エラーが発生した場合、インターフェイスポインターの値は NULL になります。
dwReservedBOOLinこのパラメーターは予約済みであり、0 以外の値でなければなりません。

戻り値の型: HRESULT

公式ドキュメント

1番目に指定したモニカー(または類似の構造を持つモニカー)の末尾に合成すると、2番目に指定したモニカーを生成するモニカーを提供します。

戻り値

この関数は、標準の戻り値である E_INVALIDARGE_OUTOFMEMORYE_UNEXPECTED に加えて、次の値を返すことができます。

戻り値 説明
S_OK
意味のある相対パスが返されました。
MK_S_HIM
相対パスの唯一の形式が、もう一方のモニカーです。
MK_E_NOTBINDABLE
pmkSrc パラメーターは項目モニカーなどの相対モニカーであり、相対パスを決定する前に、そのコンテナーのモニカーと合成する必要があります。

解説(Remarks)

IMoniker::RelativePathTo の実装では、まず、もう一方のモニカーが認識可能で特別に処理する型かどうかを確認する必要があります。そうでない場合は、自身を pmkThis として、もう一方のモニカーを pmkOther として渡し、MonikerRelativePathTo を呼び出してください。MonikerRelativePathTo は、いずれかのモニカーが汎用合成モニカーである場合を正しく処理します。

この関数は、pmkSrcpmkDest が両方とも絶対モニカーである場合にのみ呼び出してください。絶対モニカーとは、ファイルモニカー、または左端のコンポーネントがファイルモニカーである汎用合成モニカーのいずれかであり、かつそのファイルモニカーが絶対パスを表すものを指します。相対モニカーに対してこの関数を呼び出さないでください。

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

各言語での呼び出し定義

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

HRESULT MonikerRelativePathTo(
    IMoniker* pmkSrc,
    IMoniker* pmkDest,
    IMoniker** ppmkRelPath,
    BOOL dwReserved
);
[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int MonikerRelativePathTo(
    IntPtr pmkSrc,   // IMoniker*
    IntPtr pmkDest,   // IMoniker*
    IntPtr ppmkRelPath,   // IMoniker** out
    bool dwReserved   // BOOL
);
<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function MonikerRelativePathTo(
    pmkSrc As IntPtr,   ' IMoniker*
    pmkDest As IntPtr,   ' IMoniker*
    ppmkRelPath As IntPtr,   ' IMoniker** out
    dwReserved As Boolean   ' BOOL
) As Integer
End Function
' pmkSrc : IMoniker*
' pmkDest : IMoniker*
' ppmkRelPath : IMoniker** out
' dwReserved : BOOL
Declare PtrSafe Function MonikerRelativePathTo Lib "ole32" ( _
    ByVal pmkSrc As LongPtr, _
    ByVal pmkDest As LongPtr, _
    ByVal ppmkRelPath As LongPtr, _
    ByVal dwReserved As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MonikerRelativePathTo = ctypes.windll.ole32.MonikerRelativePathTo
MonikerRelativePathTo.restype = ctypes.c_int
MonikerRelativePathTo.argtypes = [
    ctypes.c_void_p,  # pmkSrc : IMoniker*
    ctypes.c_void_p,  # pmkDest : IMoniker*
    ctypes.c_void_p,  # ppmkRelPath : IMoniker** out
    wintypes.BOOL,  # dwReserved : BOOL
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procMonikerRelativePathTo = ole32.NewProc("MonikerRelativePathTo")
)

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

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

typedef MonikerRelativePathToNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, Int32);
typedef MonikerRelativePathToDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, int);
final MonikerRelativePathTo = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<MonikerRelativePathToNative, MonikerRelativePathToDart>('MonikerRelativePathTo');
// pmkSrc : IMoniker* -> Pointer<Void>
// pmkDest : IMoniker* -> Pointer<Void>
// ppmkRelPath : IMoniker** out -> Pointer<Void>
// dwReserved : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MonikerRelativePathTo(
  pmkSrc: Pointer;   // IMoniker*
  pmkDest: Pointer;   // IMoniker*
  ppmkRelPath: Pointer;   // IMoniker** out
  dwReserved: BOOL   // BOOL
): Integer; stdcall;
  external 'OLE32.dll' name 'MonikerRelativePathTo';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MonikerRelativePathTo"
  c_MonikerRelativePathTo :: Ptr () -> Ptr () -> Ptr () -> CInt -> IO Int32
-- pmkSrc : IMoniker* -> Ptr ()
-- pmkDest : IMoniker* -> Ptr ()
-- ppmkRelPath : IMoniker** out -> Ptr ()
-- dwReserved : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let monikerrelativepathto =
  foreign "MonikerRelativePathTo"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> int32_t @-> returning int32_t)
(* pmkSrc : IMoniker* -> (ptr void) *)
(* pmkDest : IMoniker* -> (ptr void) *)
(* ppmkRelPath : IMoniker** out -> (ptr void) *)
(* dwReserved : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ole32 (t "OLE32.dll"))
(cffi:use-foreign-library ole32)

(cffi:defcfun ("MonikerRelativePathTo" moniker-relative-path-to :convention :stdcall) :int32
  (pmk-src :pointer)   ; IMoniker*
  (pmk-dest :pointer)   ; IMoniker*
  (ppmk-rel-path :pointer)   ; IMoniker** out
  (dw-reserved :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MonikerRelativePathTo = Win32::API::More->new('OLE32',
    'int MonikerRelativePathTo(LPVOID pmkSrc, LPVOID pmkDest, LPVOID ppmkRelPath, BOOL dwReserved)');
# my $ret = $MonikerRelativePathTo->Call($pmkSrc, $pmkDest, $ppmkRelPath, $dwReserved);
# pmkSrc : IMoniker* -> LPVOID
# pmkDest : IMoniker* -> LPVOID
# ppmkRelPath : IMoniker** out -> LPVOID
# dwReserved : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型