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

MonikerCommonPrefixWith

関数
二つのモニカーに共通する接頭部モニカーを取得する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT MonikerCommonPrefixWith(
    IMoniker* pmkThis,
    IMoniker* pmkOther,
    IMoniker** ppmkCommon
);

パラメーター

名前方向説明
pmkThisIMoniker*in共通プレフィックスを求める対象となるいずれかのモニカーの IMoniker インターフェイスへのポインター。通常は、この呼び出しを使用して IMoniker::CommonPrefixWith を実装しているモニカーを指します。
pmkOtherIMoniker*in最初のモニカーと比較するモニカーの IMoniker インターフェイスへのポインター。
ppmkCommonIMoniker**outpmkThispmkOther の共通プレフィックスに基づくモニカーへのインターフェイスポインターを受け取る IMoniker* ポインター変数のアドレス。成功した場合、この関数はモニカーに対して AddRef を呼び出しており、呼び出し元は Release を呼び出す責任があります。エラーが発生した場合、指定されたインターフェイスポインターの値は NULL になります。

戻り値の型: HRESULT

公式ドキュメント

このモニカー(このモニカーオブジェクトのデータを構成するモニカー)が別のモニカーと共有する共通プレフィックスに基づいて、新しいモニカーを作成します。

戻り値

この関数は、標準の戻り値 E_OUTOFMEMORY および E_UNEXPECTED に加えて、次の値を返すことがあります。

戻り値 説明
S_OK
pmkThis でも pmkOther でもない共通プレフィックスが存在します。
MK_S_HIM
pmkOther モニカー全体が pmkThis モニカーのプレフィックスです。
MK_S_ME
pmkThis モニカー全体が pmkOther モニカーのプレフィックスです。
MK_S_US
pmkThis モニカーと pmkOther モニカーは等しいです。
MK_E_NOPREFIX
モニカーに共通プレフィックスがありません。
MK_E_NOTBINDABLE
この関数が相対モニカーに対して呼び出されました。相対モニカーの共通プレフィックスを求めることには意味がありません。

解説(Remarks)

IMoniker::CommonPrefixWith の実装では、まず相手のモニカーが認識可能で特別に処理する型であるかどうかを確認する必要があります。そうでない場合は、自身を pmkThis として、相手のモニカーを pmkOther として渡し、MonikerCommonPrefixWith を呼び出してください。MonikerCommonPrefixWith は、いずれかのモニカーが汎用コンポジットである場合を正しく処理します。

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

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

各言語での呼び出し定義

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

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

MonikerCommonPrefixWith = ctypes.windll.ole32.MonikerCommonPrefixWith
MonikerCommonPrefixWith.restype = ctypes.c_int
MonikerCommonPrefixWith.argtypes = [
    ctypes.c_void_p,  # pmkThis : IMoniker*
    ctypes.c_void_p,  # pmkOther : IMoniker*
    ctypes.c_void_p,  # ppmkCommon : IMoniker** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procMonikerCommonPrefixWith = ole32.NewProc("MonikerCommonPrefixWith")
)

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

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

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

foreign import stdcall safe "MonikerCommonPrefixWith"
  c_MonikerCommonPrefixWith :: Ptr () -> Ptr () -> Ptr () -> IO Int32
-- pmkThis : IMoniker* -> Ptr ()
-- pmkOther : IMoniker* -> Ptr ()
-- ppmkCommon : IMoniker** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let monikercommonprefixwith =
  foreign "MonikerCommonPrefixWith"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* pmkThis : IMoniker* -> (ptr void) *)
(* pmkOther : IMoniker* -> (ptr void) *)
(* ppmkCommon : IMoniker** 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 ("MonikerCommonPrefixWith" moniker-common-prefix-with :convention :stdcall) :int32
  (pmk-this :pointer)   ; IMoniker*
  (pmk-other :pointer)   ; IMoniker*
  (ppmk-common :pointer))   ; IMoniker** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MonikerCommonPrefixWith = Win32::API::More->new('OLE32',
    'int MonikerCommonPrefixWith(LPVOID pmkThis, LPVOID pmkOther, LPVOID ppmkCommon)');
# my $ret = $MonikerCommonPrefixWith->Call($pmkThis, $pmkOther, $ppmkCommon);
# pmkThis : IMoniker* -> LPVOID
# pmkOther : IMoniker* -> LPVOID
# ppmkCommon : IMoniker** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型