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

HlinkCreateShortcut

関数
ハイパーリンクからショートカットファイルを作成する。
DLLhlink.dll呼出規約winapi

シグネチャ

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

HRESULT HlinkCreateShortcut(
    DWORD grfHLSHORTCUTF,
    IHlink* pihl,
    LPCWSTR pwzDir,
    LPCWSTR pwzFileName,
    LPWSTR* ppwzShortcutFile,
    DWORD dwReserved
);

パラメーター

名前型方向説明
grfHLSHORTCUTFDWORDinショートカット作成動作を制御するHLSHORTCUTF_*フラグ。
pihlIHlink*inショートカット化するハイパーリンクオブジェクト。
pwzDirLPCWSTRinショートカットファイルを作成するディレクトリ。NULL可。
pwzFileNameLPCWSTRin作成するショートカットのファイル名。NULL可。
ppwzShortcutFileLPWSTR*out作成されたショートカットの完全パスを受け取る出力先。不要時はNULL可。
dwReservedDWORDin予約済みパラメータ。0を指定する。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT HlinkCreateShortcut(
    DWORD grfHLSHORTCUTF,
    IHlink* pihl,
    LPCWSTR pwzDir,
    LPCWSTR pwzFileName,
    LPWSTR* ppwzShortcutFile,
    DWORD dwReserved
);
[DllImport("hlink.dll", ExactSpelling = true)]
static extern int HlinkCreateShortcut(
    uint grfHLSHORTCUTF,   // DWORD
    IntPtr pihl,   // IHlink*
    [MarshalAs(UnmanagedType.LPWStr)] string pwzDir,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string pwzFileName,   // LPCWSTR
    IntPtr ppwzShortcutFile,   // LPWSTR* out
    uint dwReserved   // DWORD
);
<DllImport("hlink.dll", ExactSpelling:=True)>
Public Shared Function HlinkCreateShortcut(
    grfHLSHORTCUTF As UInteger,   ' DWORD
    pihl As IntPtr,   ' IHlink*
    <MarshalAs(UnmanagedType.LPWStr)> pwzDir As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> pwzFileName As String,   ' LPCWSTR
    ppwzShortcutFile As IntPtr,   ' LPWSTR* out
    dwReserved As UInteger   ' DWORD
) As Integer
End Function
' grfHLSHORTCUTF : DWORD
' pihl : IHlink*
' pwzDir : LPCWSTR
' pwzFileName : LPCWSTR
' ppwzShortcutFile : LPWSTR* out
' dwReserved : DWORD
Declare PtrSafe Function HlinkCreateShortcut Lib "hlink" ( _
    ByVal grfHLSHORTCUTF As Long, _
    ByVal pihl As LongPtr, _
    ByVal pwzDir As LongPtr, _
    ByVal pwzFileName As LongPtr, _
    ByVal ppwzShortcutFile 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

HlinkCreateShortcut = ctypes.windll.hlink.HlinkCreateShortcut
HlinkCreateShortcut.restype = ctypes.c_int
HlinkCreateShortcut.argtypes = [
    wintypes.DWORD,  # grfHLSHORTCUTF : DWORD
    ctypes.c_void_p,  # pihl : IHlink*
    wintypes.LPCWSTR,  # pwzDir : LPCWSTR
    wintypes.LPCWSTR,  # pwzFileName : LPCWSTR
    ctypes.c_void_p,  # ppwzShortcutFile : LPWSTR* out
    wintypes.DWORD,  # dwReserved : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	hlink = windows.NewLazySystemDLL("hlink.dll")
	procHlinkCreateShortcut = hlink.NewProc("HlinkCreateShortcut")
)

// grfHLSHORTCUTF (DWORD), pihl (IHlink*), pwzDir (LPCWSTR), pwzFileName (LPCWSTR), ppwzShortcutFile (LPWSTR* out), dwReserved (DWORD)
r1, _, err := procHlinkCreateShortcut.Call(
	uintptr(grfHLSHORTCUTF),
	uintptr(pihl),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pwzDir))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pwzFileName))),
	uintptr(ppwzShortcutFile),
	uintptr(dwReserved),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function HlinkCreateShortcut(
  grfHLSHORTCUTF: DWORD;   // DWORD
  pihl: Pointer;   // IHlink*
  pwzDir: PWideChar;   // LPCWSTR
  pwzFileName: PWideChar;   // LPCWSTR
  ppwzShortcutFile: PPWideChar;   // LPWSTR* out
  dwReserved: DWORD   // DWORD
): Integer; stdcall;
  external 'hlink.dll' name 'HlinkCreateShortcut';
result := DllCall("hlink\HlinkCreateShortcut"
    , "UInt", grfHLSHORTCUTF   ; DWORD
    , "Ptr", pihl   ; IHlink*
    , "WStr", pwzDir   ; LPCWSTR
    , "WStr", pwzFileName   ; LPCWSTR
    , "Ptr", ppwzShortcutFile   ; LPWSTR* out
    , "UInt", dwReserved   ; DWORD
    , "Int")   ; return: HRESULT
●HlinkCreateShortcut(grfHLSHORTCUTF, pihl, pwzDir, pwzFileName, ppwzShortcutFile, dwReserved) = DLL("hlink.dll", "int HlinkCreateShortcut(dword, void*, char*, char*, void*, dword)")
# 呼び出し: HlinkCreateShortcut(grfHLSHORTCUTF, pihl, pwzDir, pwzFileName, ppwzShortcutFile, dwReserved)
# grfHLSHORTCUTF : DWORD -> "dword"
# pihl : IHlink* -> "void*"
# pwzDir : LPCWSTR -> "char*"
# pwzFileName : LPCWSTR -> "char*"
# ppwzShortcutFile : LPWSTR* out -> "void*"
# dwReserved : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef HlinkCreateShortcutNative = Int32 Function(Uint32, Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, Pointer<Pointer<Utf16>>, Uint32);
typedef HlinkCreateShortcutDart = int Function(int, Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, Pointer<Pointer<Utf16>>, int);
final HlinkCreateShortcut = DynamicLibrary.open('hlink.dll')
    .lookupFunction<HlinkCreateShortcutNative, HlinkCreateShortcutDart>('HlinkCreateShortcut');
// grfHLSHORTCUTF : DWORD -> Uint32
// pihl : IHlink* -> Pointer<Void>
// pwzDir : LPCWSTR -> Pointer<Utf16>
// pwzFileName : LPCWSTR -> Pointer<Utf16>
// ppwzShortcutFile : LPWSTR* out -> Pointer<Pointer<Utf16>>
// dwReserved : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function HlinkCreateShortcut(
  grfHLSHORTCUTF: DWORD;   // DWORD
  pihl: Pointer;   // IHlink*
  pwzDir: PWideChar;   // LPCWSTR
  pwzFileName: PWideChar;   // LPCWSTR
  ppwzShortcutFile: PPWideChar;   // LPWSTR* out
  dwReserved: DWORD   // DWORD
): Integer; stdcall;
  external 'hlink.dll' name 'HlinkCreateShortcut';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "HlinkCreateShortcut"
  c_HlinkCreateShortcut :: Word32 -> Ptr () -> CWString -> CWString -> Ptr CWString -> Word32 -> IO Int32
-- grfHLSHORTCUTF : DWORD -> Word32
-- pihl : IHlink* -> Ptr ()
-- pwzDir : LPCWSTR -> CWString
-- pwzFileName : LPCWSTR -> CWString
-- ppwzShortcutFile : LPWSTR* out -> Ptr CWString
-- dwReserved : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let hlinkcreateshortcut =
  foreign "HlinkCreateShortcut"
    (uint32_t @-> (ptr void) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> (ptr (ptr uint16_t)) @-> uint32_t @-> returning int32_t)
(* grfHLSHORTCUTF : DWORD -> uint32_t *)
(* pihl : IHlink* -> (ptr void) *)
(* pwzDir : LPCWSTR -> (ptr uint16_t) *)
(* pwzFileName : LPCWSTR -> (ptr uint16_t) *)
(* ppwzShortcutFile : LPWSTR* out -> (ptr (ptr uint16_t)) *)
(* dwReserved : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library hlink (t "hlink.dll"))
(cffi:use-foreign-library hlink)

(cffi:defcfun ("HlinkCreateShortcut" hlink-create-shortcut :convention :stdcall) :int32
  (grf-hlshortcutf :uint32)   ; DWORD
  (pihl :pointer)   ; IHlink*
  (pwz-dir (:string :encoding :utf-16le))   ; LPCWSTR
  (pwz-file-name (:string :encoding :utf-16le))   ; LPCWSTR
  (ppwz-shortcut-file :pointer)   ; LPWSTR* out
  (dw-reserved :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $HlinkCreateShortcut = Win32::API::More->new('hlink',
    'int HlinkCreateShortcut(DWORD grfHLSHORTCUTF, LPVOID pihl, LPCWSTR pwzDir, LPCWSTR pwzFileName, LPVOID ppwzShortcutFile, DWORD dwReserved)');
# my $ret = $HlinkCreateShortcut->Call($grfHLSHORTCUTF, $pihl, $pwzDir, $pwzFileName, $ppwzShortcutFile, $dwReserved);
# grfHLSHORTCUTF : DWORD -> DWORD
# pihl : IHlink* -> LPVOID
# pwzDir : LPCWSTR -> LPCWSTR
# pwzFileName : LPCWSTR -> LPCWSTR
# ppwzShortcutFile : LPWSTR* out -> LPVOID
# dwReserved : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型