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

SHSetTemporaryPropertyForItem

関数
シェルアイテムに一時プロパティ値を設定する。
DLLSHELL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT SHSetTemporaryPropertyForItem(
    IShellItem* psi,
    const PROPERTYKEY* propkey,
    const PROPVARIANT* propvar
);

パラメーター

名前方向説明
psiIShellItem*in一時プロパティを設定する対象の項目へのポインター。
propkeyPROPERTYKEY*in設定する一時プロパティを識別する PROPERTYKEY への参照。
propvarPROPVARIANT*in一時プロパティの値を格納する PROPVARIANT への参照。

戻り値の型: HRESULT

公式ドキュメント

指定した項目に一時プロパティを設定します。一時プロパティは、項目に書き戻されるのではなく、IShellItem オブジェクトの存続期間中のみプロパティを保持する読み取り/書き込みストアに格納されます。

戻り値

型: HRESULT

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

解説(Remarks)

一時的な値は、SHGetTemporaryPropertyForItem を使用するか、または IShellItem2::GetPropertyStoreGPS_TEMPORARY を渡すことによってのみ読み取ることができます。

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

各言語での呼び出し定義

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

HRESULT SHSetTemporaryPropertyForItem(
    IShellItem* psi,
    const PROPERTYKEY* propkey,
    const PROPVARIANT* propvar
);
[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHSetTemporaryPropertyForItem(
    IntPtr psi,   // IShellItem*
    IntPtr propkey,   // PROPERTYKEY*
    IntPtr propvar   // PROPVARIANT*
);
<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHSetTemporaryPropertyForItem(
    psi As IntPtr,   ' IShellItem*
    propkey As IntPtr,   ' PROPERTYKEY*
    propvar As IntPtr   ' PROPVARIANT*
) As Integer
End Function
' psi : IShellItem*
' propkey : PROPERTYKEY*
' propvar : PROPVARIANT*
Declare PtrSafe Function SHSetTemporaryPropertyForItem Lib "shell32" ( _
    ByVal psi As LongPtr, _
    ByVal propkey As LongPtr, _
    ByVal propvar As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHSetTemporaryPropertyForItem = ctypes.windll.shell32.SHSetTemporaryPropertyForItem
SHSetTemporaryPropertyForItem.restype = ctypes.c_int
SHSetTemporaryPropertyForItem.argtypes = [
    ctypes.c_void_p,  # psi : IShellItem*
    ctypes.c_void_p,  # propkey : PROPERTYKEY*
    ctypes.c_void_p,  # propvar : PROPVARIANT*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHSetTemporaryPropertyForItem = Fiddle::Function.new(
  lib['SHSetTemporaryPropertyForItem'],
  [
    Fiddle::TYPE_VOIDP,  # psi : IShellItem*
    Fiddle::TYPE_VOIDP,  # propkey : PROPERTYKEY*
    Fiddle::TYPE_VOIDP,  # propvar : PROPVARIANT*
  ],
  Fiddle::TYPE_INT)
#[link(name = "shell32")]
extern "system" {
    fn SHSetTemporaryPropertyForItem(
        psi: *mut core::ffi::c_void,  // IShellItem*
        propkey: *const PROPERTYKEY,  // PROPERTYKEY*
        propvar: *const PROPVARIANT  // PROPVARIANT*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHELL32.dll")]
public static extern int SHSetTemporaryPropertyForItem(IntPtr psi, IntPtr propkey, IntPtr propvar);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHSetTemporaryPropertyForItem' -Namespace Win32 -PassThru
# $api::SHSetTemporaryPropertyForItem(psi, propkey, propvar)
#uselib "SHELL32.dll"
#func global SHSetTemporaryPropertyForItem "SHSetTemporaryPropertyForItem" sptr, sptr, sptr
; SHSetTemporaryPropertyForItem psi, varptr(propkey), varptr(propvar)   ; 戻り値は stat
; psi : IShellItem* -> "sptr"
; propkey : PROPERTYKEY* -> "sptr"
; propvar : PROPVARIANT* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHELL32.dll"
#cfunc global SHSetTemporaryPropertyForItem "SHSetTemporaryPropertyForItem" sptr, var, var
; res = SHSetTemporaryPropertyForItem(psi, propkey, propvar)
; psi : IShellItem* -> "sptr"
; propkey : PROPERTYKEY* -> "var"
; propvar : PROPVARIANT* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT SHSetTemporaryPropertyForItem(IShellItem* psi, PROPERTYKEY* propkey, PROPVARIANT* propvar)
#uselib "SHELL32.dll"
#cfunc global SHSetTemporaryPropertyForItem "SHSetTemporaryPropertyForItem" intptr, var, var
; res = SHSetTemporaryPropertyForItem(psi, propkey, propvar)
; psi : IShellItem* -> "intptr"
; propkey : PROPERTYKEY* -> "var"
; propvar : PROPVARIANT* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHSetTemporaryPropertyForItem = shell32.NewProc("SHSetTemporaryPropertyForItem")
)

// psi (IShellItem*), propkey (PROPERTYKEY*), propvar (PROPVARIANT*)
r1, _, err := procSHSetTemporaryPropertyForItem.Call(
	uintptr(psi),
	uintptr(propkey),
	uintptr(propvar),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function SHSetTemporaryPropertyForItem(
  psi: Pointer;   // IShellItem*
  propkey: Pointer;   // PROPERTYKEY*
  propvar: Pointer   // PROPVARIANT*
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHSetTemporaryPropertyForItem';
result := DllCall("SHELL32\SHSetTemporaryPropertyForItem"
    , "Ptr", psi   ; IShellItem*
    , "Ptr", propkey   ; PROPERTYKEY*
    , "Ptr", propvar   ; PROPVARIANT*
    , "Int")   ; return: HRESULT
●SHSetTemporaryPropertyForItem(psi, propkey, propvar) = DLL("SHELL32.dll", "int SHSetTemporaryPropertyForItem(void*, void*, void*)")
# 呼び出し: SHSetTemporaryPropertyForItem(psi, propkey, propvar)
# psi : IShellItem* -> "void*"
# propkey : PROPERTYKEY* -> "void*"
# propvar : PROPVARIANT* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef SHSetTemporaryPropertyForItemNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef SHSetTemporaryPropertyForItemDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
final SHSetTemporaryPropertyForItem = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHSetTemporaryPropertyForItemNative, SHSetTemporaryPropertyForItemDart>('SHSetTemporaryPropertyForItem');
// psi : IShellItem* -> Pointer<Void>
// propkey : PROPERTYKEY* -> Pointer<Void>
// propvar : PROPVARIANT* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHSetTemporaryPropertyForItem(
  psi: Pointer;   // IShellItem*
  propkey: Pointer;   // PROPERTYKEY*
  propvar: Pointer   // PROPVARIANT*
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHSetTemporaryPropertyForItem';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHSetTemporaryPropertyForItem"
  c_SHSetTemporaryPropertyForItem :: Ptr () -> Ptr () -> Ptr () -> IO Int32
-- psi : IShellItem* -> Ptr ()
-- propkey : PROPERTYKEY* -> Ptr ()
-- propvar : PROPVARIANT* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shsettemporarypropertyforitem =
  foreign "SHSetTemporaryPropertyForItem"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* psi : IShellItem* -> (ptr void) *)
(* propkey : PROPERTYKEY* -> (ptr void) *)
(* propvar : PROPVARIANT* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("SHSetTemporaryPropertyForItem" shset-temporary-property-for-item :convention :stdcall) :int32
  (psi :pointer)   ; IShellItem*
  (propkey :pointer)   ; PROPERTYKEY*
  (propvar :pointer))   ; PROPVARIANT*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHSetTemporaryPropertyForItem = Win32::API::More->new('SHELL32',
    'int SHSetTemporaryPropertyForItem(LPVOID psi, LPVOID propkey, LPVOID propvar)');
# my $ret = $SHSetTemporaryPropertyForItem->Call($psi, $propkey, $propvar);
# psi : IShellItem* -> LPVOID
# propkey : PROPERTYKEY* -> LPVOID
# propvar : PROPVARIANT* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型