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

CreateItemMoniker

関数
コンテナ内の項目を識別するアイテムモニカーを作成する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT CreateItemMoniker(
    LPCWSTR lpszDelim,
    LPCWSTR lpszItem,
    IMoniker** ppmk
);

パラメーター

名前方向説明
lpszDelimLPCWSTRinこのアイテムの表示名を格納オブジェクトの表示名から区切るために使用する区切り文字(通常は "!")を含む、ゼロ終端のワイド文字列(1 文字あたり 2 バイト)へのポインターです。
lpszItemLPCWSTRin識別対象のオブジェクトについて、格納オブジェクトが付与した名前を示すゼロ終端文字列へのポインターです。この名前は後で IOleItemContainer::GetObject の呼び出しでオブジェクトへのポインターを取得するために使用できます。
ppmkIMoniker**outアイテムモニカーへのインターフェイスポインターを受け取る IMoniker* ポインター変数のアドレスです。成功した場合、この関数はアイテムモニカーに対して AddRef を呼び出しており、呼び出し元が Release を呼び出す責任を負います。エラーが発生した場合、提供されたインターフェイスポインターは NULL 値になります。

戻り値の型: HRESULT

公式ドキュメント

格納オブジェクト(通常は複合ドキュメント)内のオブジェクトを識別するアイテムモニカーを作成します。

戻り値

この関数は標準の戻り値 E_OUTOFMEMORY および S_OK を返すことができます。

解説(Remarks)

モニカープロバイダーは、自身のオブジェクトを他者からアクセス可能にするためにそれらを識別するモニカーを配布しますが、自身のオブジェクトをアイテムモニカーで識別するために CreateItemMoniker を呼び出します。アイテムモニカーは文字列に基づいており、別のオブジェクト内に格納され、文字列を使用して個別に識別できるオブジェクトを識別します。格納オブジェクトは IOleContainer インターフェイスも実装する必要があります。

ほとんどのモニカープロバイダーはリンクをサポートする OLE アプリケーションです。ドキュメント内の選択範囲へのリンクを許可するサーバーアプリケーションなど、ファイルベースのドキュメントより小さいオブジェクトへのリンクをサポートするアプリケーションは、それらのオブジェクトを識別するためにアイテムモニカーを使用する必要があります。埋め込みオブジェクトへのリンクを許可するコンテナーアプリケーションは、埋め込みオブジェクトを識別するためにアイテムモニカーを使用します。

lpszItem パラメーターは、ドキュメントがオブジェクトを一意に識別するために使用する名前です。たとえば、識別対象のオブジェクトがスプレッドシート内のセル範囲である場合、適切な名前は "A1:E7" のようなものになります。識別対象のオブジェクトが埋め込みオブジェクトである場合、適切な名前は "embedobj1" のようなものになります。格納オブジェクトは、この名前を解釈して対応するオブジェクトを特定できる IOleItemContainer インターフェイスの実装を提供する必要があります。これにより、アイテムモニカーをそれが識別するオブジェクトにバインドできます。

アイテムモニカーは単独では使用されません。格納オブジェクトを識別するモニカーと合成する必要があります。たとえば、識別対象のオブジェクトがファイルベースのドキュメントに含まれるセル範囲である場合、そのオブジェクトを識別するアイテムモニカーは、そのドキュメントを識別するファイルモニカーと合成する必要があり、結果として "C:\work\sales.xls!A1:E7" に相当する複合モニカーが得られます。

オブジェクトが別のドキュメント内の埋め込みオブジェクト内に格納されている場合のように、ネストされたコンテナーも許可されます。そのようなオブジェクトの完全なモニカーは "C:\work\report.doc!embedobj1!A1:E7" に相当します。この場合、各格納オブジェクトは CreateItemMoniker を呼び出し、独自の IOleItemContainer インターフェイスの実装を提供する必要があります。

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

各言語での呼び出し定義

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

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

CreateItemMoniker = ctypes.windll.ole32.CreateItemMoniker
CreateItemMoniker.restype = ctypes.c_int
CreateItemMoniker.argtypes = [
    wintypes.LPCWSTR,  # lpszDelim : LPCWSTR
    wintypes.LPCWSTR,  # lpszItem : LPCWSTR
    ctypes.c_void_p,  # ppmk : IMoniker** out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
CreateItemMoniker = Fiddle::Function.new(
  lib['CreateItemMoniker'],
  [
    Fiddle::TYPE_VOIDP,  # lpszDelim : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpszItem : LPCWSTR
    Fiddle::TYPE_VOIDP,  # ppmk : IMoniker** out
  ],
  Fiddle::TYPE_INT)
#[link(name = "ole32")]
extern "system" {
    fn CreateItemMoniker(
        lpszDelim: *const u16,  // LPCWSTR
        lpszItem: *const u16,  // LPCWSTR
        ppmk: *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 CreateItemMoniker([MarshalAs(UnmanagedType.LPWStr)] string lpszDelim, [MarshalAs(UnmanagedType.LPWStr)] string lpszItem, IntPtr ppmk);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_CreateItemMoniker' -Namespace Win32 -PassThru
# $api::CreateItemMoniker(lpszDelim, lpszItem, ppmk)
#uselib "OLE32.dll"
#func global CreateItemMoniker "CreateItemMoniker" sptr, sptr, sptr
; CreateItemMoniker lpszDelim, lpszItem, ppmk   ; 戻り値は stat
; lpszDelim : LPCWSTR -> "sptr"
; lpszItem : LPCWSTR -> "sptr"
; ppmk : IMoniker** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "OLE32.dll"
#cfunc global CreateItemMoniker "CreateItemMoniker" wstr, wstr, sptr
; res = CreateItemMoniker(lpszDelim, lpszItem, ppmk)
; lpszDelim : LPCWSTR -> "wstr"
; lpszItem : LPCWSTR -> "wstr"
; ppmk : IMoniker** out -> "sptr"
; HRESULT CreateItemMoniker(LPCWSTR lpszDelim, LPCWSTR lpszItem, IMoniker** ppmk)
#uselib "OLE32.dll"
#cfunc global CreateItemMoniker "CreateItemMoniker" wstr, wstr, intptr
; res = CreateItemMoniker(lpszDelim, lpszItem, ppmk)
; lpszDelim : LPCWSTR -> "wstr"
; lpszItem : LPCWSTR -> "wstr"
; ppmk : IMoniker** out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procCreateItemMoniker = ole32.NewProc("CreateItemMoniker")
)

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

extern "ole32" fn CreateItemMoniker(
    lpszDelim: [*c]const u16, // LPCWSTR
    lpszItem: [*c]const u16, // LPCWSTR
    ppmk: ?*anyopaque // IMoniker** out
) callconv(std.os.windows.WINAPI) i32;
proc CreateItemMoniker(
    lpszDelim: WideCString,  # LPCWSTR
    lpszItem: WideCString,  # LPCWSTR
    ppmk: pointer  # IMoniker** out
): int32 {.importc: "CreateItemMoniker", stdcall, dynlib: "OLE32.dll".}
pragma(lib, "ole32");
extern(Windows)
int CreateItemMoniker(
    const(wchar)* lpszDelim,   // LPCWSTR
    const(wchar)* lpszItem,   // LPCWSTR
    void* ppmk   // IMoniker** out
);
ccall((:CreateItemMoniker, "OLE32.dll"), stdcall, Int32,
      (Cwstring, Cwstring, Ptr{Cvoid}),
      lpszDelim, lpszItem, ppmk)
# lpszDelim : LPCWSTR -> Cwstring
# lpszItem : LPCWSTR -> Cwstring
# ppmk : IMoniker** out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t CreateItemMoniker(
    const uint16_t* lpszDelim,
    const uint16_t* lpszItem,
    void* ppmk);
]]
local ole32 = ffi.load("ole32")
-- ole32.CreateItemMoniker(lpszDelim, lpszItem, ppmk)
-- lpszDelim : LPCWSTR
-- lpszItem : LPCWSTR
-- ppmk : IMoniker** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('OLE32.dll');
const CreateItemMoniker = lib.func('__stdcall', 'CreateItemMoniker', 'int32_t', ['str16', 'str16', 'void *']);
// CreateItemMoniker(lpszDelim, lpszItem, ppmk)
// lpszDelim : LPCWSTR -> 'str16'
// lpszItem : LPCWSTR -> 'str16'
// ppmk : IMoniker** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("OLE32.dll", {
  CreateItemMoniker: { parameters: ["buffer", "buffer", "pointer"], result: "i32" },
});
// lib.symbols.CreateItemMoniker(lpszDelim, lpszItem, ppmk)
// lpszDelim : LPCWSTR -> "buffer"
// lpszItem : LPCWSTR -> "buffer"
// ppmk : IMoniker** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CreateItemMoniker(
    const uint16_t* lpszDelim,
    const uint16_t* lpszItem,
    void* ppmk);
C, "OLE32.dll");
// $ffi->CreateItemMoniker(lpszDelim, lpszItem, ppmk);
// lpszDelim : LPCWSTR
// lpszItem : LPCWSTR
// ppmk : 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 CreateItemMoniker(
        WString lpszDelim,   // LPCWSTR
        WString lpszItem,   // LPCWSTR
        Pointer ppmk   // IMoniker** out
    );
}
@[Link("ole32")]
lib LibOLE32
  fun CreateItemMoniker = CreateItemMoniker(
    lpszDelim : UInt16*,   # LPCWSTR
    lpszItem : UInt16*,   # LPCWSTR
    ppmk : 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 CreateItemMonikerNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Void>);
typedef CreateItemMonikerDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Void>);
final CreateItemMoniker = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<CreateItemMonikerNative, CreateItemMonikerDart>('CreateItemMoniker');
// lpszDelim : LPCWSTR -> Pointer<Utf16>
// lpszItem : LPCWSTR -> Pointer<Utf16>
// ppmk : IMoniker** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CreateItemMoniker(
  lpszDelim: PWideChar;   // LPCWSTR
  lpszItem: PWideChar;   // LPCWSTR
  ppmk: Pointer   // IMoniker** out
): Integer; stdcall;
  external 'OLE32.dll' name 'CreateItemMoniker';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CreateItemMoniker"
  c_CreateItemMoniker :: CWString -> CWString -> Ptr () -> IO Int32
-- lpszDelim : LPCWSTR -> CWString
-- lpszItem : LPCWSTR -> CWString
-- ppmk : IMoniker** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let createitemmoniker =
  foreign "CreateItemMoniker"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr void) @-> returning int32_t)
(* lpszDelim : LPCWSTR -> (ptr uint16_t) *)
(* lpszItem : LPCWSTR -> (ptr uint16_t) *)
(* ppmk : 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 ("CreateItemMoniker" create-item-moniker :convention :stdcall) :int32
  (lpsz-delim (:string :encoding :utf-16le))   ; LPCWSTR
  (lpsz-item (:string :encoding :utf-16le))   ; LPCWSTR
  (ppmk :pointer))   ; IMoniker** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CreateItemMoniker = Win32::API::More->new('OLE32',
    'int CreateItemMoniker(LPCWSTR lpszDelim, LPCWSTR lpszItem, LPVOID ppmk)');
# my $ret = $CreateItemMoniker->Call($lpszDelim, $lpszItem, $ppmk);
# lpszDelim : LPCWSTR -> LPCWSTR
# lpszItem : LPCWSTR -> LPCWSTR
# ppmk : IMoniker** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型