CreateFileMoniker
関数シグネチャ
// OLE32.dll
#include <windows.h>
HRESULT CreateFileMoniker(
LPCWSTR lpszPathName,
IMoniker** ppmk
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| lpszPathName | LPCWSTR | in | このモニカーの基準となるパスです。 このパラメーターには、相対パス、UNC パス、またはドライブレターベースのパスを指定できます。相対パスに基づく場合、作成されたモニカーはバインドする前に別のファイルモニカーと合成する必要があります。 |
| ppmk | IMoniker** | out | 新しいファイルモニカーへのインターフェイスポインターを受け取る IMoniker* ポインター変数のアドレスです。成功した場合、この関数はファイルモニカーに対して AddRef を呼び出しており、呼び出し側は Release を呼び出す責任があります。エラーが発生した場合、インターフェイスポインターの値は NULL になります。 |
戻り値の型: HRESULT
公式ドキュメント
指定されたパスに基づいてファイルモニカーを作成します。
戻り値
この関数は、標準の戻り値 E_OUTOFMEMORY のほか、次の値を返すことがあります。
| 戻り値 | 説明 |
|---|---|
| モニカーが正常に作成されました。 | |
| パスの構文にエラーがありました。 |
解説(Remarks)
CreateFileMoniker は、ファイルに格納されているオブジェクトのモニカーを作成します。モニカープロバイダー(他のオブジェクトにモニカーを提供するオブジェクト)は、この関数を呼び出して、自身が制御するファイルベースのオブジェクトを識別するモニカーを作成し、このモニカーへのポインターを他のオブジェクトが利用できるようにします。ファイルモニカーによって識別されるオブジェクトは、ファイルモニカーがバインドされたときに読み込まれるように、IPersistFile インターフェイスも実装する必要があります。
ファイルベースのドキュメント全体へのリンクのみをサポートする OLE サーバーアプリケーションのように、各オブジェクトが独自のファイルに存在する場合、ファイルモニカーが必要となる唯一の種類のモニカーです。ファイルより小さいオブジェクトを識別するには、モニカープロバイダーはファイルモニカーに加えて別の種類のモニカー(アイテムモニカーなど)を使用し、複合モニカーを作成する必要があります。複合モニカーは、ドキュメントより小さいオブジェクト(ドキュメントの一部や埋め込みオブジェクトなど)へのリンクをサポートする OLE サーバーアプリケーションで必要になります。
ファイルモニカーは、最初のモニカーが絶対パスに基づき、もう一方が相対パスである場合に限り、別のファイルモニカーの右側にのみ合成でき、その結果、2 つのパスを組み合わせた単一のファイルモニカーが生成されます。別のモニカーの右側に合成されるモニカーは、そのモニカーの絞り込みでなければならず、ファイルモニカーは最大の記憶単位を表します。ファイル内に格納されているオブジェクトを識別するには、ファイルモニカーの右側に他の種類のモニカー(通常はアイテムモニカー)を合成します。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// OLE32.dll
#include <windows.h>
HRESULT CreateFileMoniker(
LPCWSTR lpszPathName,
IMoniker** ppmk
);[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int CreateFileMoniker(
[MarshalAs(UnmanagedType.LPWStr)] string lpszPathName, // LPCWSTR
IntPtr ppmk // IMoniker** out
);<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function CreateFileMoniker(
<MarshalAs(UnmanagedType.LPWStr)> lpszPathName As String, ' LPCWSTR
ppmk As IntPtr ' IMoniker** out
) As Integer
End Function' lpszPathName : LPCWSTR
' ppmk : IMoniker** out
Declare PtrSafe Function CreateFileMoniker Lib "ole32" ( _
ByVal lpszPathName 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
CreateFileMoniker = ctypes.windll.ole32.CreateFileMoniker
CreateFileMoniker.restype = ctypes.c_int
CreateFileMoniker.argtypes = [
wintypes.LPCWSTR, # lpszPathName : LPCWSTR
ctypes.c_void_p, # ppmk : IMoniker** out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('OLE32.dll')
CreateFileMoniker = Fiddle::Function.new(
lib['CreateFileMoniker'],
[
Fiddle::TYPE_VOIDP, # lpszPathName : LPCWSTR
Fiddle::TYPE_VOIDP, # ppmk : IMoniker** out
],
Fiddle::TYPE_INT)#[link(name = "ole32")]
extern "system" {
fn CreateFileMoniker(
lpszPathName: *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 CreateFileMoniker([MarshalAs(UnmanagedType.LPWStr)] string lpszPathName, IntPtr ppmk);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_CreateFileMoniker' -Namespace Win32 -PassThru
# $api::CreateFileMoniker(lpszPathName, ppmk)#uselib "OLE32.dll"
#func global CreateFileMoniker "CreateFileMoniker" sptr, sptr
; CreateFileMoniker lpszPathName, ppmk ; 戻り値は stat
; lpszPathName : LPCWSTR -> "sptr"
; ppmk : IMoniker** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "OLE32.dll"
#cfunc global CreateFileMoniker "CreateFileMoniker" wstr, sptr
; res = CreateFileMoniker(lpszPathName, ppmk)
; lpszPathName : LPCWSTR -> "wstr"
; ppmk : IMoniker** out -> "sptr"; HRESULT CreateFileMoniker(LPCWSTR lpszPathName, IMoniker** ppmk)
#uselib "OLE32.dll"
#cfunc global CreateFileMoniker "CreateFileMoniker" wstr, intptr
; res = CreateFileMoniker(lpszPathName, ppmk)
; lpszPathName : LPCWSTR -> "wstr"
; ppmk : IMoniker** out -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
ole32 = windows.NewLazySystemDLL("OLE32.dll")
procCreateFileMoniker = ole32.NewProc("CreateFileMoniker")
)
// lpszPathName (LPCWSTR), ppmk (IMoniker** out)
r1, _, err := procCreateFileMoniker.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszPathName))),
uintptr(ppmk),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction CreateFileMoniker(
lpszPathName: PWideChar; // LPCWSTR
ppmk: Pointer // IMoniker** out
): Integer; stdcall;
external 'OLE32.dll' name 'CreateFileMoniker';result := DllCall("OLE32\CreateFileMoniker"
, "WStr", lpszPathName ; LPCWSTR
, "Ptr", ppmk ; IMoniker** out
, "Int") ; return: HRESULT●CreateFileMoniker(lpszPathName, ppmk) = DLL("OLE32.dll", "int CreateFileMoniker(char*, void*)")
# 呼び出し: CreateFileMoniker(lpszPathName, ppmk)
# lpszPathName : LPCWSTR -> "char*"
# ppmk : IMoniker** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "ole32" fn CreateFileMoniker(
lpszPathName: [*c]const u16, // LPCWSTR
ppmk: ?*anyopaque // IMoniker** out
) callconv(std.os.windows.WINAPI) i32;proc CreateFileMoniker(
lpszPathName: WideCString, # LPCWSTR
ppmk: pointer # IMoniker** out
): int32 {.importc: "CreateFileMoniker", stdcall, dynlib: "OLE32.dll".}pragma(lib, "ole32");
extern(Windows)
int CreateFileMoniker(
const(wchar)* lpszPathName, // LPCWSTR
void* ppmk // IMoniker** out
);ccall((:CreateFileMoniker, "OLE32.dll"), stdcall, Int32,
(Cwstring, Ptr{Cvoid}),
lpszPathName, ppmk)
# lpszPathName : LPCWSTR -> Cwstring
# ppmk : IMoniker** out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t CreateFileMoniker(
const uint16_t* lpszPathName,
void* ppmk);
]]
local ole32 = ffi.load("ole32")
-- ole32.CreateFileMoniker(lpszPathName, ppmk)
-- lpszPathName : LPCWSTR
-- ppmk : IMoniker** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('OLE32.dll');
const CreateFileMoniker = lib.func('__stdcall', 'CreateFileMoniker', 'int32_t', ['str16', 'void *']);
// CreateFileMoniker(lpszPathName, ppmk)
// lpszPathName : LPCWSTR -> 'str16'
// ppmk : IMoniker** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("OLE32.dll", {
CreateFileMoniker: { parameters: ["buffer", "pointer"], result: "i32" },
});
// lib.symbols.CreateFileMoniker(lpszPathName, ppmk)
// lpszPathName : LPCWSTR -> "buffer"
// ppmk : IMoniker** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t CreateFileMoniker(
const uint16_t* lpszPathName,
void* ppmk);
C, "OLE32.dll");
// $ffi->CreateFileMoniker(lpszPathName, ppmk);
// lpszPathName : 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 CreateFileMoniker(
WString lpszPathName, // LPCWSTR
Pointer ppmk // IMoniker** out
);
}@[Link("ole32")]
lib LibOLE32
fun CreateFileMoniker = CreateFileMoniker(
lpszPathName : 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 CreateFileMonikerNative = Int32 Function(Pointer<Utf16>, Pointer<Void>);
typedef CreateFileMonikerDart = int Function(Pointer<Utf16>, Pointer<Void>);
final CreateFileMoniker = DynamicLibrary.open('OLE32.dll')
.lookupFunction<CreateFileMonikerNative, CreateFileMonikerDart>('CreateFileMoniker');
// lpszPathName : LPCWSTR -> Pointer<Utf16>
// ppmk : IMoniker** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function CreateFileMoniker(
lpszPathName: PWideChar; // LPCWSTR
ppmk: Pointer // IMoniker** out
): Integer; stdcall;
external 'OLE32.dll' name 'CreateFileMoniker';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "CreateFileMoniker"
c_CreateFileMoniker :: CWString -> Ptr () -> IO Int32
-- lpszPathName : LPCWSTR -> CWString
-- ppmk : IMoniker** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let createfilemoniker =
foreign "CreateFileMoniker"
((ptr uint16_t) @-> (ptr void) @-> returning int32_t)
(* lpszPathName : 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 ("CreateFileMoniker" create-file-moniker :convention :stdcall) :int32
(lpsz-path-name (: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 $CreateFileMoniker = Win32::API::More->new('OLE32',
'int CreateFileMoniker(LPCWSTR lpszPathName, LPVOID ppmk)');
# my $ret = $CreateFileMoniker->Call($lpszPathName, $ppmk);
# lpszPathName : LPCWSTR -> LPCWSTR
# ppmk : IMoniker** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。