Win32 API 日本語リファレンス
ホームUI.Shell › HlinkParseDisplayName

HlinkParseDisplayName

関数
表示名を解析してモニカーへ変換する。
DLLhlink.dll呼出規約winapi

シグネチャ

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

HRESULT HlinkParseDisplayName(
    IBindCtx* pibc,
    LPCWSTR pwzDisplayName,
    BOOL fNoForceAbs,
    DWORD* pcchEaten,
    IMoniker** ppimk
);

パラメーター

名前方向説明
pibcIBindCtx*in解析に用いるバインドコンテキスト。NULL可。
pwzDisplayNameLPCWSTRin解析対象の表示名文字列(URLやパス)。
fNoForceAbsBOOLinTRUEなら絶対URLへの強制変換を行わない。
pcchEatenDWORD*inout解析で消費した文字数を受け取る出力先。
ppimkIMoniker**out解析結果として生成されたモニカを受け取る出力先。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT HlinkParseDisplayName(
    IBindCtx* pibc,
    LPCWSTR pwzDisplayName,
    BOOL fNoForceAbs,
    DWORD* pcchEaten,
    IMoniker** ppimk
);
[DllImport("hlink.dll", ExactSpelling = true)]
static extern int HlinkParseDisplayName(
    IntPtr pibc,   // IBindCtx*
    [MarshalAs(UnmanagedType.LPWStr)] string pwzDisplayName,   // LPCWSTR
    bool fNoForceAbs,   // BOOL
    ref uint pcchEaten,   // DWORD* in/out
    IntPtr ppimk   // IMoniker** out
);
<DllImport("hlink.dll", ExactSpelling:=True)>
Public Shared Function HlinkParseDisplayName(
    pibc As IntPtr,   ' IBindCtx*
    <MarshalAs(UnmanagedType.LPWStr)> pwzDisplayName As String,   ' LPCWSTR
    fNoForceAbs As Boolean,   ' BOOL
    ByRef pcchEaten As UInteger,   ' DWORD* in/out
    ppimk As IntPtr   ' IMoniker** out
) As Integer
End Function
' pibc : IBindCtx*
' pwzDisplayName : LPCWSTR
' fNoForceAbs : BOOL
' pcchEaten : DWORD* in/out
' ppimk : IMoniker** out
Declare PtrSafe Function HlinkParseDisplayName Lib "hlink" ( _
    ByVal pibc As LongPtr, _
    ByVal pwzDisplayName As LongPtr, _
    ByVal fNoForceAbs As Long, _
    ByRef pcchEaten As Long, _
    ByVal ppimk As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

HlinkParseDisplayName = ctypes.windll.hlink.HlinkParseDisplayName
HlinkParseDisplayName.restype = ctypes.c_int
HlinkParseDisplayName.argtypes = [
    ctypes.c_void_p,  # pibc : IBindCtx*
    wintypes.LPCWSTR,  # pwzDisplayName : LPCWSTR
    wintypes.BOOL,  # fNoForceAbs : BOOL
    ctypes.POINTER(wintypes.DWORD),  # pcchEaten : DWORD* in/out
    ctypes.c_void_p,  # ppimk : IMoniker** out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('hlink.dll')
HlinkParseDisplayName = Fiddle::Function.new(
  lib['HlinkParseDisplayName'],
  [
    Fiddle::TYPE_VOIDP,  # pibc : IBindCtx*
    Fiddle::TYPE_VOIDP,  # pwzDisplayName : LPCWSTR
    Fiddle::TYPE_INT,  # fNoForceAbs : BOOL
    Fiddle::TYPE_VOIDP,  # pcchEaten : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # ppimk : IMoniker** out
  ],
  Fiddle::TYPE_INT)
#[link(name = "hlink")]
extern "system" {
    fn HlinkParseDisplayName(
        pibc: *mut core::ffi::c_void,  // IBindCtx*
        pwzDisplayName: *const u16,  // LPCWSTR
        fNoForceAbs: i32,  // BOOL
        pcchEaten: *mut u32,  // DWORD* in/out
        ppimk: *mut *mut core::ffi::c_void  // IMoniker** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("hlink.dll")]
public static extern int HlinkParseDisplayName(IntPtr pibc, [MarshalAs(UnmanagedType.LPWStr)] string pwzDisplayName, bool fNoForceAbs, ref uint pcchEaten, IntPtr ppimk);
"@
$api = Add-Type -MemberDefinition $sig -Name 'hlink_HlinkParseDisplayName' -Namespace Win32 -PassThru
# $api::HlinkParseDisplayName(pibc, pwzDisplayName, fNoForceAbs, pcchEaten, ppimk)
#uselib "hlink.dll"
#func global HlinkParseDisplayName "HlinkParseDisplayName" sptr, sptr, sptr, sptr, sptr
; HlinkParseDisplayName pibc, pwzDisplayName, fNoForceAbs, varptr(pcchEaten), ppimk   ; 戻り値は stat
; pibc : IBindCtx* -> "sptr"
; pwzDisplayName : LPCWSTR -> "sptr"
; fNoForceAbs : BOOL -> "sptr"
; pcchEaten : DWORD* in/out -> "sptr"
; ppimk : IMoniker** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "hlink.dll"
#cfunc global HlinkParseDisplayName "HlinkParseDisplayName" sptr, wstr, int, var, sptr
; res = HlinkParseDisplayName(pibc, pwzDisplayName, fNoForceAbs, pcchEaten, ppimk)
; pibc : IBindCtx* -> "sptr"
; pwzDisplayName : LPCWSTR -> "wstr"
; fNoForceAbs : BOOL -> "int"
; pcchEaten : DWORD* in/out -> "var"
; ppimk : IMoniker** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT HlinkParseDisplayName(IBindCtx* pibc, LPCWSTR pwzDisplayName, BOOL fNoForceAbs, DWORD* pcchEaten, IMoniker** ppimk)
#uselib "hlink.dll"
#cfunc global HlinkParseDisplayName "HlinkParseDisplayName" intptr, wstr, int, var, intptr
; res = HlinkParseDisplayName(pibc, pwzDisplayName, fNoForceAbs, pcchEaten, ppimk)
; pibc : IBindCtx* -> "intptr"
; pwzDisplayName : LPCWSTR -> "wstr"
; fNoForceAbs : BOOL -> "int"
; pcchEaten : DWORD* in/out -> "var"
; ppimk : IMoniker** out -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	hlink = windows.NewLazySystemDLL("hlink.dll")
	procHlinkParseDisplayName = hlink.NewProc("HlinkParseDisplayName")
)

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

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

foreign import stdcall safe "HlinkParseDisplayName"
  c_HlinkParseDisplayName :: Ptr () -> CWString -> CInt -> Ptr Word32 -> Ptr () -> IO Int32
-- pibc : IBindCtx* -> Ptr ()
-- pwzDisplayName : LPCWSTR -> CWString
-- fNoForceAbs : BOOL -> CInt
-- pcchEaten : DWORD* in/out -> Ptr Word32
-- ppimk : IMoniker** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let hlinkparsedisplayname =
  foreign "HlinkParseDisplayName"
    ((ptr void) @-> (ptr uint16_t) @-> int32_t @-> (ptr uint32_t) @-> (ptr void) @-> returning int32_t)
(* pibc : IBindCtx* -> (ptr void) *)
(* pwzDisplayName : LPCWSTR -> (ptr uint16_t) *)
(* fNoForceAbs : BOOL -> int32_t *)
(* pcchEaten : DWORD* in/out -> (ptr uint32_t) *)
(* ppimk : IMoniker** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library hlink (t "hlink.dll"))
(cffi:use-foreign-library hlink)

(cffi:defcfun ("HlinkParseDisplayName" hlink-parse-display-name :convention :stdcall) :int32
  (pibc :pointer)   ; IBindCtx*
  (pwz-display-name (:string :encoding :utf-16le))   ; LPCWSTR
  (f-no-force-abs :int32)   ; BOOL
  (pcch-eaten :pointer)   ; DWORD* in/out
  (ppimk :pointer))   ; IMoniker** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $HlinkParseDisplayName = Win32::API::More->new('hlink',
    'int HlinkParseDisplayName(LPVOID pibc, LPCWSTR pwzDisplayName, BOOL fNoForceAbs, LPVOID pcchEaten, LPVOID ppimk)');
# my $ret = $HlinkParseDisplayName->Call($pibc, $pwzDisplayName, $fNoForceAbs, $pcchEaten, $ppimk);
# pibc : IBindCtx* -> LPVOID
# pwzDisplayName : LPCWSTR -> LPCWSTR
# fNoForceAbs : BOOL -> BOOL
# pcchEaten : DWORD* in/out -> LPVOID
# ppimk : IMoniker** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型