ホーム › UI.Shell › SHGetNewLinkInfoW

SHGetNewLinkInfoW

関数

新規ショートカット作成に必要な情報を取得する。

DLLSHELL32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// SHELL32.dll  (Unicode / -W)
#include <windows.h>

BOOL SHGetNewLinkInfoW(
    LPCWSTR pszLinkTo,
    LPCWSTR pszDir,
    LPWSTR pszName,
    BOOL* pfMustCopy,
    DWORD uFlags
);

パラメーター

名前	型	方向	説明
pszLinkTo	LPCWSTR	in	ショートカットのリンク先となるファイル/フォルダーのパス(Unicode)。
pszDir	LPCWSTR	in	ショートカットを作成するディレクトリのパス。重複しない名前の生成に使用される。
pszName	LPWSTR	out	生成されたショートカットファイル名を受け取る出力バッファ。MAX_PATH分を確保する。
pfMustCopy	BOOL*	out	ショートカット作成前にファイルのコピーが必要かを示すBOOLを受け取る出力ポインタ。
uFlags	DWORD	in	リンク情報の取得方法を指定するSHGNLI_*フラグの組み合わせ。

戻り値の型: BOOL

各言語での呼び出し定義

// SHELL32.dll  (Unicode / -W)
#include <windows.h>

BOOL SHGetNewLinkInfoW(
    LPCWSTR pszLinkTo,
    LPCWSTR pszDir,
    LPWSTR pszName,
    BOOL* pfMustCopy,
    DWORD uFlags
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool SHGetNewLinkInfoW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszLinkTo,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string pszDir,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszName,   // LPWSTR out
    out int pfMustCopy,   // BOOL* out
    uint uFlags   // DWORD
);

<DllImport("SHELL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHGetNewLinkInfoW(
    <MarshalAs(UnmanagedType.LPWStr)> pszLinkTo As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> pszDir As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> pszName As System.Text.StringBuilder,   ' LPWSTR out
    <Out> ByRef pfMustCopy As Integer,   ' BOOL* out
    uFlags As UInteger   ' DWORD
) As Boolean
End Function

' pszLinkTo : LPCWSTR
' pszDir : LPCWSTR
' pszName : LPWSTR out
' pfMustCopy : BOOL* out
' uFlags : DWORD
Declare PtrSafe Function SHGetNewLinkInfoW Lib "shell32" ( _
    ByVal pszLinkTo As LongPtr, _
    ByVal pszDir As LongPtr, _
    ByVal pszName As LongPtr, _
    ByRef pfMustCopy As Long, _
    ByVal uFlags As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHGetNewLinkInfoW = ctypes.windll.shell32.SHGetNewLinkInfoW
SHGetNewLinkInfoW.restype = wintypes.BOOL
SHGetNewLinkInfoW.argtypes = [
    wintypes.LPCWSTR,  # pszLinkTo : LPCWSTR
    wintypes.LPCWSTR,  # pszDir : LPCWSTR
    wintypes.LPWSTR,  # pszName : LPWSTR out
    ctypes.c_void_p,  # pfMustCopy : BOOL* out
    wintypes.DWORD,  # uFlags : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHGetNewLinkInfoW = Fiddle::Function.new(
  lib['SHGetNewLinkInfoW'],
  [
    Fiddle::TYPE_VOIDP,  # pszLinkTo : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pszDir : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pszName : LPWSTR out
    Fiddle::TYPE_VOIDP,  # pfMustCopy : BOOL* out
    -Fiddle::TYPE_INT,  # uFlags : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "shell32")]
extern "system" {
    fn SHGetNewLinkInfoW(
        pszLinkTo: *const u16,  // LPCWSTR
        pszDir: *const u16,  // LPCWSTR
        pszName: *mut u16,  // LPWSTR out
        pfMustCopy: *mut i32,  // BOOL* out
        uFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode)]
public static extern bool SHGetNewLinkInfoW([MarshalAs(UnmanagedType.LPWStr)] string pszLinkTo, [MarshalAs(UnmanagedType.LPWStr)] string pszDir, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszName, out int pfMustCopy, uint uFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHGetNewLinkInfoW' -Namespace Win32 -PassThru
# $api::SHGetNewLinkInfoW(pszLinkTo, pszDir, pszName, pfMustCopy, uFlags)

#uselib "SHELL32.dll"
#func global SHGetNewLinkInfoW "SHGetNewLinkInfoW" wptr, wptr, wptr, wptr, wptr
; SHGetNewLinkInfoW pszLinkTo, pszDir, varptr(pszName), pfMustCopy, uFlags   ; 戻り値は stat
; pszLinkTo : LPCWSTR -> "wptr"
; pszDir : LPCWSTR -> "wptr"
; pszName : LPWSTR out -> "wptr"
; pfMustCopy : BOOL* out -> "wptr"
; uFlags : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHELL32.dll"
#cfunc global SHGetNewLinkInfoW "SHGetNewLinkInfoW" wstr, wstr, var, int, int
; res = SHGetNewLinkInfoW(pszLinkTo, pszDir, pszName, pfMustCopy, uFlags)
; pszLinkTo : LPCWSTR -> "wstr"
; pszDir : LPCWSTR -> "wstr"
; pszName : LPWSTR out -> "var"
; pfMustCopy : BOOL* out -> "int"
; uFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHELL32.dll"
#cfunc global SHGetNewLinkInfoW "SHGetNewLinkInfoW" wstr, wstr, sptr, int, int
; res = SHGetNewLinkInfoW(pszLinkTo, pszDir, varptr(pszName), pfMustCopy, uFlags)
; pszLinkTo : LPCWSTR -> "wstr"
; pszDir : LPCWSTR -> "wstr"
; pszName : LPWSTR out -> "sptr"
; pfMustCopy : BOOL* out -> "int"
; uFlags : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; BOOL SHGetNewLinkInfoW(LPCWSTR pszLinkTo, LPCWSTR pszDir, LPWSTR pszName, BOOL* pfMustCopy, DWORD uFlags)
#uselib "SHELL32.dll"
#cfunc global SHGetNewLinkInfoW "SHGetNewLinkInfoW" wstr, wstr, var, int, int
; res = SHGetNewLinkInfoW(pszLinkTo, pszDir, pszName, pfMustCopy, uFlags)
; pszLinkTo : LPCWSTR -> "wstr"
; pszDir : LPCWSTR -> "wstr"
; pszName : LPWSTR out -> "var"
; pfMustCopy : BOOL* out -> "int"
; uFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL SHGetNewLinkInfoW(LPCWSTR pszLinkTo, LPCWSTR pszDir, LPWSTR pszName, BOOL* pfMustCopy, DWORD uFlags)
#uselib "SHELL32.dll"
#cfunc global SHGetNewLinkInfoW "SHGetNewLinkInfoW" wstr, wstr, intptr, int, int
; res = SHGetNewLinkInfoW(pszLinkTo, pszDir, varptr(pszName), pfMustCopy, uFlags)
; pszLinkTo : LPCWSTR -> "wstr"
; pszDir : LPCWSTR -> "wstr"
; pszName : LPWSTR out -> "intptr"
; pfMustCopy : BOOL* out -> "int"
; uFlags : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHGetNewLinkInfoW = shell32.NewProc("SHGetNewLinkInfoW")
)

// pszLinkTo (LPCWSTR), pszDir (LPCWSTR), pszName (LPWSTR out), pfMustCopy (BOOL* out), uFlags (DWORD)
r1, _, err := procSHGetNewLinkInfoW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszLinkTo))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszDir))),
	uintptr(pszName),
	uintptr(pfMustCopy),
	uintptr(uFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function SHGetNewLinkInfoW(
  pszLinkTo: PWideChar;   // LPCWSTR
  pszDir: PWideChar;   // LPCWSTR
  pszName: PWideChar;   // LPWSTR out
  pfMustCopy: Pointer;   // BOOL* out
  uFlags: DWORD   // DWORD
): BOOL; stdcall;
  external 'SHELL32.dll' name 'SHGetNewLinkInfoW';

result := DllCall("SHELL32\SHGetNewLinkInfoW"
    , "WStr", pszLinkTo   ; LPCWSTR
    , "WStr", pszDir   ; LPCWSTR
    , "Ptr", pszName   ; LPWSTR out
    , "Ptr", pfMustCopy   ; BOOL* out
    , "UInt", uFlags   ; DWORD
    , "Int")   ; return: BOOL

●SHGetNewLinkInfoW(pszLinkTo, pszDir, pszName, pfMustCopy, uFlags) = DLL("SHELL32.dll", "bool SHGetNewLinkInfoW(char*, char*, char*, void*, dword)")
# 呼び出し: SHGetNewLinkInfoW(pszLinkTo, pszDir, pszName, pfMustCopy, uFlags)
# pszLinkTo : LPCWSTR -> "char*"
# pszDir : LPCWSTR -> "char*"
# pszName : LPWSTR out -> "char*"
# pfMustCopy : BOOL* out -> "void*"
# uFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。