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

SHGetNewLinkInfoA

関数
新規ショートカット作成に必要な情報を取得する。
DLLSHELL32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// SHELL32.dll  (ANSI / -A)
#include <windows.h>

BOOL SHGetNewLinkInfoA(
    LPCSTR pszLinkTo,
    LPCSTR pszDir,
    LPSTR pszName,
    BOOL* pfMustCopy,
    DWORD uFlags
);

パラメーター

名前方向説明
pszLinkToLPCSTRinショートカットのターゲットのパスとファイル名へのポインターです。uFlagsSHGNLI_PIDL 値が含まれていない場合、このパラメーターはターゲットを格納する null 終端文字列のアドレスです。uFlagsSHGNLI_PIDL 値が含まれている場合、このパラメーターはターゲットを表す PIDL です。
pszDirLPCSTRinショートカットを作成するフォルダーのパスを格納する null 終端文字列へのポインターです。
pszNameLPSTRoutショートカットの null 終端のパスとファイル名を受け取る文字列へのポインターです。このバッファーは少なくとも MAX_PATH 文字分のサイズがあるものとみなされます。
pfMustCopyBOOL*outショートカットがコピーされるかどうかを示すフラグを受け取る BOOL 値のアドレスです。別のショートカットへのショートカットを作成する場合、シェルは単純にターゲットのショートカットをコピーし、そのコピーしたショートカットを適切に変更します。pszLinkTo で指定したターゲットが、ターゲットのショートカットのコピーを引き起こすショートカットを指している場合、このパラメーターは 0 以外の値を受け取ります。ターゲットがコピーされるショートカットを指していない場合、このパラメーターは 0 を受け取ります。
uFlagsDWORDin

関数のオプションです。0、または以下の値の組み合わせを指定できます。

SHGNLI_PIDL (0x000000001)

0x000000001。pszLinkTo が指すターゲットは、ターゲットを表す PIDL です。このフラグが含まれていない場合、pszLinkTo はターゲットのパスとファイル名を格納する文字列のアドレスとみなされます。

SHGNLI_NOUNIQUE (0x000000002)

0x000000002。ショートカット名が宛先フォルダー内で一意であることを保証する通常のチェックをスキップします。このフラグが含まれていない場合、関数はショートカット名を作成した後、その名前が宛先フォルダー内で一意かどうかを判定します。同じ名前のファイルが宛先フォルダーに既に存在する場合、ショートカット名は変更されます。この処理は一意な名前が見つかるまで繰り返されます。

SHGNLI_PREFIXNAME (0x000000004)

0x000000004。作成される名前の前に文字列「Shortcut to 」が付加されます。

SHGNLI_NOLNK (0x000000008)

0x000000008。バージョン 5.0 .lnk ファイル名拡張子を付加しません。このフラグを使用するには、_WIN32_IE マクロを 5.01 以上に設定する必要があります。バージョン管理の詳細については、「Shell and Common Controls Versions」を参照してください。

SHGNLI_NOLOCNAME (0x000000010)

0x000000010。Windows Vista 以降pszLinkTo が指すターゲットのローカライズされていない解析名を、ショートカットファイルの名前として使用します。このフラグが設定されていない場合、ローカライズされた名前が使用されます。

SHGNLI_USEURLEXT (0x000000020)

0x000000020。Windows 7 以降pszName が指す名前に、(.lnk ではなく).url ファイル名拡張子を付加します。このフラグが設定されていない場合、SHGNLI_NOLNK が設定されていない限り、ショートカット名には .lnk 拡張子が使用されます。

戻り値の型: BOOL

公式ドキュメント

ショートカットの対象として指定されたターゲットに基づいて、新しいショートカットの名前を作成します。この関数はショートカットそのものを作成するのではなく、名前のみを作成します。(ANSI)

戻り値

型: BOOL

成功した場合は TRUE を、それ以外の場合は FALSE を返します。

解説(Remarks)

SHGetNewLinkInfo は、宛先のファイルシステムが長いファイル名をサポートしているかどうかを判定します。サポートしている場合、ショートカット名には長いファイル名が使用されます。宛先のファイルシステムが長いファイル名をサポートしていない場合、ショートカット名は 8.3 形式で返されます。

メモ

shellapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SHGetNewLinkInfo を定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、「Conventions for Function Prototypes」を参照してください。

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

各言語での呼び出し定義

// SHELL32.dll  (ANSI / -A)
#include <windows.h>

BOOL SHGetNewLinkInfoA(
    LPCSTR pszLinkTo,
    LPCSTR pszDir,
    LPSTR pszName,
    BOOL* pfMustCopy,
    DWORD uFlags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool SHGetNewLinkInfoA(
    [MarshalAs(UnmanagedType.LPStr)] string pszLinkTo,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string pszDir,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszName,   // LPSTR out
    out bool pfMustCopy,   // BOOL* out
    uint uFlags   // DWORD
);
<DllImport("SHELL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHGetNewLinkInfoA(
    <MarshalAs(UnmanagedType.LPStr)> pszLinkTo As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> pszDir As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> pszName As System.Text.StringBuilder,   ' LPSTR out
    <Out> ByRef pfMustCopy As Boolean,   ' BOOL* out
    uFlags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pszLinkTo : LPCSTR
' pszDir : LPCSTR
' pszName : LPSTR out
' pfMustCopy : BOOL* out
' uFlags : DWORD
Declare PtrSafe Function SHGetNewLinkInfoA Lib "shell32" ( _
    ByVal pszLinkTo As String, _
    ByVal pszDir As String, _
    ByVal pszName As String, _
    ByRef pfMustCopy As Long, _
    ByVal uFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHGetNewLinkInfoA = ctypes.windll.shell32.SHGetNewLinkInfoA
SHGetNewLinkInfoA.restype = wintypes.BOOL
SHGetNewLinkInfoA.argtypes = [
    wintypes.LPCSTR,  # pszLinkTo : LPCSTR
    wintypes.LPCSTR,  # pszDir : LPCSTR
    wintypes.LPSTR,  # pszName : LPSTR out
    ctypes.c_void_p,  # pfMustCopy : BOOL* out
    wintypes.DWORD,  # uFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHGetNewLinkInfoA = Fiddle::Function.new(
  lib['SHGetNewLinkInfoA'],
  [
    Fiddle::TYPE_VOIDP,  # pszLinkTo : LPCSTR
    Fiddle::TYPE_VOIDP,  # pszDir : LPCSTR
    Fiddle::TYPE_VOIDP,  # pszName : LPSTR out
    Fiddle::TYPE_VOIDP,  # pfMustCopy : BOOL* out
    -Fiddle::TYPE_INT,  # uFlags : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "shell32")]
extern "system" {
    fn SHGetNewLinkInfoA(
        pszLinkTo: *const u8,  // LPCSTR
        pszDir: *const u8,  // LPCSTR
        pszName: *mut u8,  // LPSTR 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.Ansi)]
public static extern bool SHGetNewLinkInfoA([MarshalAs(UnmanagedType.LPStr)] string pszLinkTo, [MarshalAs(UnmanagedType.LPStr)] string pszDir, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszName, out bool pfMustCopy, uint uFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHGetNewLinkInfoA' -Namespace Win32 -PassThru
# $api::SHGetNewLinkInfoA(pszLinkTo, pszDir, pszName, pfMustCopy, uFlags)
#uselib "SHELL32.dll"
#func global SHGetNewLinkInfoA "SHGetNewLinkInfoA" sptr, sptr, sptr, sptr, sptr
; SHGetNewLinkInfoA pszLinkTo, pszDir, varptr(pszName), varptr(pfMustCopy), uFlags   ; 戻り値は stat
; pszLinkTo : LPCSTR -> "sptr"
; pszDir : LPCSTR -> "sptr"
; pszName : LPSTR out -> "sptr"
; pfMustCopy : BOOL* out -> "sptr"
; uFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHELL32.dll"
#cfunc global SHGetNewLinkInfoA "SHGetNewLinkInfoA" str, str, var, var, int
; res = SHGetNewLinkInfoA(pszLinkTo, pszDir, pszName, pfMustCopy, uFlags)
; pszLinkTo : LPCSTR -> "str"
; pszDir : LPCSTR -> "str"
; pszName : LPSTR out -> "var"
; pfMustCopy : BOOL* out -> "var"
; uFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SHGetNewLinkInfoA(LPCSTR pszLinkTo, LPCSTR pszDir, LPSTR pszName, BOOL* pfMustCopy, DWORD uFlags)
#uselib "SHELL32.dll"
#cfunc global SHGetNewLinkInfoA "SHGetNewLinkInfoA" str, str, var, var, int
; res = SHGetNewLinkInfoA(pszLinkTo, pszDir, pszName, pfMustCopy, uFlags)
; pszLinkTo : LPCSTR -> "str"
; pszDir : LPCSTR -> "str"
; pszName : LPSTR out -> "var"
; pfMustCopy : BOOL* out -> "var"
; uFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHGetNewLinkInfoA = shell32.NewProc("SHGetNewLinkInfoA")
)

// pszLinkTo (LPCSTR), pszDir (LPCSTR), pszName (LPSTR out), pfMustCopy (BOOL* out), uFlags (DWORD)
r1, _, err := procSHGetNewLinkInfoA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszLinkTo))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszDir))),
	uintptr(pszName),
	uintptr(pfMustCopy),
	uintptr(uFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SHGetNewLinkInfoA(
  pszLinkTo: PAnsiChar;   // LPCSTR
  pszDir: PAnsiChar;   // LPCSTR
  pszName: PAnsiChar;   // LPSTR out
  pfMustCopy: Pointer;   // BOOL* out
  uFlags: DWORD   // DWORD
): BOOL; stdcall;
  external 'SHELL32.dll' name 'SHGetNewLinkInfoA';
result := DllCall("SHELL32\SHGetNewLinkInfoA"
    , "AStr", pszLinkTo   ; LPCSTR
    , "AStr", pszDir   ; LPCSTR
    , "Ptr", pszName   ; LPSTR out
    , "Ptr", pfMustCopy   ; BOOL* out
    , "UInt", uFlags   ; DWORD
    , "Int")   ; return: BOOL
●SHGetNewLinkInfoA(pszLinkTo, pszDir, pszName, pfMustCopy, uFlags) = DLL("SHELL32.dll", "bool SHGetNewLinkInfoA(char*, char*, char*, void*, dword)")
# 呼び出し: SHGetNewLinkInfoA(pszLinkTo, pszDir, pszName, pfMustCopy, uFlags)
# pszLinkTo : LPCSTR -> "char*"
# pszDir : LPCSTR -> "char*"
# pszName : LPSTR out -> "char*"
# pfMustCopy : BOOL* out -> "void*"
# uFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "shell32" fn SHGetNewLinkInfoA(
    pszLinkTo: [*c]const u8, // LPCSTR
    pszDir: [*c]const u8, // LPCSTR
    pszName: [*c]u8, // LPSTR out
    pfMustCopy: [*c]i32, // BOOL* out
    uFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc SHGetNewLinkInfoA(
    pszLinkTo: cstring,  # LPCSTR
    pszDir: cstring,  # LPCSTR
    pszName: ptr char,  # LPSTR out
    pfMustCopy: ptr int32,  # BOOL* out
    uFlags: uint32  # DWORD
): int32 {.importc: "SHGetNewLinkInfoA", stdcall, dynlib: "SHELL32.dll".}
pragma(lib, "shell32");
extern(Windows)
int SHGetNewLinkInfoA(
    const(char)* pszLinkTo,   // LPCSTR
    const(char)* pszDir,   // LPCSTR
    char* pszName,   // LPSTR out
    int* pfMustCopy,   // BOOL* out
    uint uFlags   // DWORD
);
ccall((:SHGetNewLinkInfoA, "SHELL32.dll"), stdcall, Int32,
      (Cstring, Cstring, Ptr{UInt8}, Ptr{Int32}, UInt32),
      pszLinkTo, pszDir, pszName, pfMustCopy, uFlags)
# pszLinkTo : LPCSTR -> Cstring
# pszDir : LPCSTR -> Cstring
# pszName : LPSTR out -> Ptr{UInt8}
# pfMustCopy : BOOL* out -> Ptr{Int32}
# uFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SHGetNewLinkInfoA(
    const char* pszLinkTo,
    const char* pszDir,
    char* pszName,
    int32_t* pfMustCopy,
    uint32_t uFlags);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHGetNewLinkInfoA(pszLinkTo, pszDir, pszName, pfMustCopy, uFlags)
-- pszLinkTo : LPCSTR
-- pszDir : LPCSTR
-- pszName : LPSTR out
-- pfMustCopy : BOOL* out
-- uFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const SHGetNewLinkInfoA = lib.func('__stdcall', 'SHGetNewLinkInfoA', 'int32_t', ['str', 'str', 'char *', 'int32_t *', 'uint32_t']);
// SHGetNewLinkInfoA(pszLinkTo, pszDir, pszName, pfMustCopy, uFlags)
// pszLinkTo : LPCSTR -> 'str'
// pszDir : LPCSTR -> 'str'
// pszName : LPSTR out -> 'char *'
// pfMustCopy : BOOL* out -> 'int32_t *'
// uFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHELL32.dll", {
  SHGetNewLinkInfoA: { parameters: ["buffer", "buffer", "buffer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.SHGetNewLinkInfoA(pszLinkTo, pszDir, pszName, pfMustCopy, uFlags)
// pszLinkTo : LPCSTR -> "buffer"
// pszDir : LPCSTR -> "buffer"
// pszName : LPSTR out -> "buffer"
// pfMustCopy : BOOL* out -> "pointer"
// uFlags : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SHGetNewLinkInfoA(
    const char* pszLinkTo,
    const char* pszDir,
    char* pszName,
    int32_t* pfMustCopy,
    uint32_t uFlags);
C, "SHELL32.dll");
// $ffi->SHGetNewLinkInfoA(pszLinkTo, pszDir, pszName, pfMustCopy, uFlags);
// pszLinkTo : LPCSTR
// pszDir : LPCSTR
// pszName : LPSTR out
// pfMustCopy : BOOL* out
// uFlags : 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 Shell32 extends StdCallLibrary {
    Shell32 INSTANCE = Native.load("shell32", Shell32.class, W32APIOptions.ASCII_OPTIONS);
    boolean SHGetNewLinkInfoA(
        String pszLinkTo,   // LPCSTR
        String pszDir,   // LPCSTR
        byte[] pszName,   // LPSTR out
        IntByReference pfMustCopy,   // BOOL* out
        int uFlags   // DWORD
    );
}
@[Link("shell32")]
lib LibSHELL32
  fun SHGetNewLinkInfoA = SHGetNewLinkInfoA(
    pszLinkTo : UInt8*,   # LPCSTR
    pszDir : UInt8*,   # LPCSTR
    pszName : UInt8*,   # LPSTR out
    pfMustCopy : Int32*,   # BOOL* out
    uFlags : 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 SHGetNewLinkInfoANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Int32>, Uint32);
typedef SHGetNewLinkInfoADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Int32>, int);
final SHGetNewLinkInfoA = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHGetNewLinkInfoANative, SHGetNewLinkInfoADart>('SHGetNewLinkInfoA');
// pszLinkTo : LPCSTR -> Pointer<Utf8>
// pszDir : LPCSTR -> Pointer<Utf8>
// pszName : LPSTR out -> Pointer<Utf8>
// pfMustCopy : BOOL* out -> Pointer<Int32>
// uFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHGetNewLinkInfoA(
  pszLinkTo: PAnsiChar;   // LPCSTR
  pszDir: PAnsiChar;   // LPCSTR
  pszName: PAnsiChar;   // LPSTR out
  pfMustCopy: Pointer;   // BOOL* out
  uFlags: DWORD   // DWORD
): BOOL; stdcall;
  external 'SHELL32.dll' name 'SHGetNewLinkInfoA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHGetNewLinkInfoA"
  c_SHGetNewLinkInfoA :: CString -> CString -> CString -> Ptr CInt -> Word32 -> IO CInt
-- pszLinkTo : LPCSTR -> CString
-- pszDir : LPCSTR -> CString
-- pszName : LPSTR out -> CString
-- pfMustCopy : BOOL* out -> Ptr CInt
-- uFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shgetnewlinkinfoa =
  foreign "SHGetNewLinkInfoA"
    (string @-> string @-> string @-> (ptr int32_t) @-> uint32_t @-> returning int32_t)
(* pszLinkTo : LPCSTR -> string *)
(* pszDir : LPCSTR -> string *)
(* pszName : LPSTR out -> string *)
(* pfMustCopy : BOOL* out -> (ptr int32_t) *)
(* uFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("SHGetNewLinkInfoA" shget-new-link-info-a :convention :stdcall) :int32
  (psz-link-to :string)   ; LPCSTR
  (psz-dir :string)   ; LPCSTR
  (psz-name :pointer)   ; LPSTR out
  (pf-must-copy :pointer)   ; BOOL* out
  (u-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHGetNewLinkInfoA = Win32::API::More->new('SHELL32',
    'BOOL SHGetNewLinkInfoA(LPCSTR pszLinkTo, LPCSTR pszDir, LPSTR pszName, LPVOID pfMustCopy, DWORD uFlags)');
# my $ret = $SHGetNewLinkInfoA->Call($pszLinkTo, $pszDir, $pszName, $pfMustCopy, $uFlags);
# pszLinkTo : LPCSTR -> LPCSTR
# pszDir : LPCSTR -> LPCSTR
# pszName : LPSTR out -> LPSTR
# pfMustCopy : BOOL* out -> LPVOID
# uFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い