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

SHCreateItemInKnownFolder

関数
既知フォルダー内の項目からシェルアイテムを作成する。
DLLSHELL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT SHCreateItemInKnownFolder(
    const GUID* kfid,
    DWORD dwKFFlags,
    LPCWSTR pszItem,   // optional
    const GUID* riid,
    void** ppv
);

パラメーター

名前方向説明
kfidGUID*inアイテムを含むフォルダーを識別する GUID である KNOWNFOLDERID への参照。
dwKFFlagsDWORDinオブジェクトの取得における特別なオプションを指定するフラグ。この値は 0 にすることができます。それ以外の場合は、1 つ以上の KNOWN_FOLDER_FLAG 値を指定します。
pszItemLPCWSTRinoptional新しいアイテムのファイル名を Unicode 文字列として格納する、null で終わるバッファーへのポインター。このパラメーターは NULL にすることもできます。その場合、既知のフォルダー自体を表す IShellItem が作成されます。
riidGUID*inppv を通じて取得される、アイテムを表すインターフェイスの IID への参照。この値は通常 IID_IShellItem または IID_IShellItem2 です。
ppvvoid**outこの関数が正常に終了すると、riid で要求されたインターフェイスポインターが格納されます。これは通常 IShellItem または IShellItem2 です。

戻り値の型: HRESULT

公式ドキュメント

既知のフォルダー内に存在する単一のファイルに対する Shell アイテムオブジェクトを作成します。

戻り値

型: HRESULT

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

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

各言語での呼び出し定義

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

HRESULT SHCreateItemInKnownFolder(
    const GUID* kfid,
    DWORD dwKFFlags,
    LPCWSTR pszItem,   // optional
    const GUID* riid,
    void** ppv
);
[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHCreateItemInKnownFolder(
    ref Guid kfid,   // GUID*
    uint dwKFFlags,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string pszItem,   // LPCWSTR optional
    ref Guid riid,   // GUID*
    IntPtr ppv   // void** out
);
<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHCreateItemInKnownFolder(
    ByRef kfid As Guid,   ' GUID*
    dwKFFlags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> pszItem As String,   ' LPCWSTR optional
    ByRef riid As Guid,   ' GUID*
    ppv As IntPtr   ' void** out
) As Integer
End Function
' kfid : GUID*
' dwKFFlags : DWORD
' pszItem : LPCWSTR optional
' riid : GUID*
' ppv : void** out
Declare PtrSafe Function SHCreateItemInKnownFolder Lib "shell32" ( _
    ByVal kfid As LongPtr, _
    ByVal dwKFFlags As Long, _
    ByVal pszItem As LongPtr, _
    ByVal riid As LongPtr, _
    ByVal ppv As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHCreateItemInKnownFolder = ctypes.windll.shell32.SHCreateItemInKnownFolder
SHCreateItemInKnownFolder.restype = ctypes.c_int
SHCreateItemInKnownFolder.argtypes = [
    ctypes.c_void_p,  # kfid : GUID*
    wintypes.DWORD,  # dwKFFlags : DWORD
    wintypes.LPCWSTR,  # pszItem : LPCWSTR optional
    ctypes.c_void_p,  # riid : GUID*
    ctypes.c_void_p,  # ppv : void** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHCreateItemInKnownFolder = shell32.NewProc("SHCreateItemInKnownFolder")
)

// kfid (GUID*), dwKFFlags (DWORD), pszItem (LPCWSTR optional), riid (GUID*), ppv (void** out)
r1, _, err := procSHCreateItemInKnownFolder.Call(
	uintptr(kfid),
	uintptr(dwKFFlags),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszItem))),
	uintptr(riid),
	uintptr(ppv),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function SHCreateItemInKnownFolder(
  kfid: PGUID;   // GUID*
  dwKFFlags: DWORD;   // DWORD
  pszItem: PWideChar;   // LPCWSTR optional
  riid: PGUID;   // GUID*
  ppv: Pointer   // void** out
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHCreateItemInKnownFolder';
result := DllCall("SHELL32\SHCreateItemInKnownFolder"
    , "Ptr", kfid   ; GUID*
    , "UInt", dwKFFlags   ; DWORD
    , "WStr", pszItem   ; LPCWSTR optional
    , "Ptr", riid   ; GUID*
    , "Ptr", ppv   ; void** out
    , "Int")   ; return: HRESULT
●SHCreateItemInKnownFolder(kfid, dwKFFlags, pszItem, riid, ppv) = DLL("SHELL32.dll", "int SHCreateItemInKnownFolder(void*, dword, char*, void*, void*)")
# 呼び出し: SHCreateItemInKnownFolder(kfid, dwKFFlags, pszItem, riid, ppv)
# kfid : GUID* -> "void*"
# dwKFFlags : DWORD -> "dword"
# pszItem : LPCWSTR optional -> "char*"
# riid : GUID* -> "void*"
# ppv : void** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef SHCreateItemInKnownFolderNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Utf16>, Pointer<Void>, Pointer<Void>);
typedef SHCreateItemInKnownFolderDart = int Function(Pointer<Void>, int, Pointer<Utf16>, Pointer<Void>, Pointer<Void>);
final SHCreateItemInKnownFolder = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHCreateItemInKnownFolderNative, SHCreateItemInKnownFolderDart>('SHCreateItemInKnownFolder');
// kfid : GUID* -> Pointer<Void>
// dwKFFlags : DWORD -> Uint32
// pszItem : LPCWSTR optional -> Pointer<Utf16>
// riid : GUID* -> Pointer<Void>
// ppv : void** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHCreateItemInKnownFolder(
  kfid: PGUID;   // GUID*
  dwKFFlags: DWORD;   // DWORD
  pszItem: PWideChar;   // LPCWSTR optional
  riid: PGUID;   // GUID*
  ppv: Pointer   // void** out
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHCreateItemInKnownFolder';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHCreateItemInKnownFolder"
  c_SHCreateItemInKnownFolder :: Ptr () -> Word32 -> CWString -> Ptr () -> Ptr () -> IO Int32
-- kfid : GUID* -> Ptr ()
-- dwKFFlags : DWORD -> Word32
-- pszItem : LPCWSTR optional -> CWString
-- riid : GUID* -> Ptr ()
-- ppv : void** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shcreateiteminknownfolder =
  foreign "SHCreateItemInKnownFolder"
    ((ptr void) @-> uint32_t @-> (ptr uint16_t) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* kfid : GUID* -> (ptr void) *)
(* dwKFFlags : DWORD -> uint32_t *)
(* pszItem : LPCWSTR optional -> (ptr uint16_t) *)
(* riid : GUID* -> (ptr void) *)
(* ppv : void** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("SHCreateItemInKnownFolder" shcreate-item-in-known-folder :convention :stdcall) :int32
  (kfid :pointer)   ; GUID*
  (dw-kfflags :uint32)   ; DWORD
  (psz-item (:string :encoding :utf-16le))   ; LPCWSTR optional
  (riid :pointer)   ; GUID*
  (ppv :pointer))   ; void** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHCreateItemInKnownFolder = Win32::API::More->new('SHELL32',
    'int SHCreateItemInKnownFolder(LPVOID kfid, DWORD dwKFFlags, LPCWSTR pszItem, LPVOID riid, LPVOID ppv)');
# my $ret = $SHCreateItemInKnownFolder->Call($kfid, $dwKFFlags, $pszItem, $riid, $ppv);
# kfid : GUID* -> LPVOID
# dwKFFlags : DWORD -> DWORD
# pszItem : LPCWSTR optional -> LPCWSTR
# riid : GUID* -> LPVOID
# ppv : void** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。