SHAddToRecentDocs
関数シグネチャ
// SHELL32.dll
#include <windows.h>
void SHAddToRecentDocs(
DWORD uFlags,
const void* pv // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| uFlags | DWORD | in | pv パラメーターが指す情報の形式を示す、SHARD 列挙型の値。 |
| pv | void* | inoptional | アクセスされた項目を識別するデータへのポインター。項目は、このパラメーターで次のいずれかの形式で指定できます。
すべての項目に関するすべての使用状況データをクリアするには、このパラメーターを NULL に設定します。 |
戻り値の型: void
公式ドキュメント
最近使用した項目および使用頻度の高い項目を追跡する目的で、項目がアクセスされたことをシステムに通知します。この関数は、すべての使用状況データをクリアするためにも使用できます。
解説(Remarks)
このメソッドの呼び出しを通じて収集される使用統計は、最近アクセスした項目および最も頻繁にアクセスした項目のリストを決定するために使用されます。これらのリストは、スタート メニューに表示され、Windows 7 以降ではアプリケーションのジャンプリストにも表示されます。
このメソッドが呼び出されると、次の領域に影響します。
- 関連付けられたアプリケーションのジャンプリストの 最近 および 頻繁 リストを更新します。
- ユーザーの Recent フォルダー (FOLDERID_Recent、CSIDL_RECENT) にショートカットを追加します。これは、スタート メニューの 最近使ったファイル (Windows XP) および 最近使った項目 (Windows Vista 以降) メニューに反映されます。
- クラシック スタート メニューの ドキュメント サブメニューにショートカットを追加します。(クラシック スタート メニューオプションは Windows 7 以降では利用できないことに注意してください。)
ユーザーが Windows エクスプローラーを通じて項目を開く場合や、共通ファイルダイアログを使用してファイルを開く、保存する、または作成する場合など、一部のケースでは、シェルがアプリケーションに代わって SHAddToRecentDocs を呼び出します。項目を選択するためのカスタム UI を持つアプリケーションは、正確な統計を確保するために、明示的に SHAddToRecentDocs を呼び出す必要があります。重複した呼び出しはシステムによって考慮されるため、そうすることでデータが歪むリスクはありません。
実行可能 (.exe) ファイルは、Windows XP 以降のバージョンでは最近使用したドキュメントのリストから除外されます。SHAddToRecentDocs は実行可能ファイルのパスを受け付けますが、そのファイルは 最近使った項目 リストには表示されません。
フォルダーも SHAddToRecentDocs によって受け付けられますが、Windows エクスプローラーのタスクバーボタンのジャンプリストにのみ表示されます。フォルダーは他のどのアプリケーションのジャンプリストにも表示されません。
特定のケースでは、SHAddToRecentDocs は、処理するように登録されていないファイルタイプを処理するためにアプリケーションを登録しようとします。これは次の状況で発生します。
- アプリケーションが、処理するように登録されていないファイルタイプを指定して明示的に SHAddToRecentDocs を呼び出す場合。これは、共通ファイルダイアログがアプリケーションに代わって行う SHAddToRecentDocs の呼び出しにも適用されますが、ダイアログがファイルを開くために使用される場合のみであり、保存するために使用される場合は適用されません。
- ユーザーが、アプリケーションが処理するように登録されていないタイプのファイルを、アプリケーションのタスクバーボタンにドロップする場合。
登録を正常に完了するには、一連の要件を満たす必要があります。
- アプリケーションは HKEY_CLASSES_ROOT\Applications の下に登録されている必要があります。
- その登録に NoOpenWith 値を含めることはできません。NoOpenWith の詳細については、ファイルタイプ を参照してください。
- その登録は SupportedTypes サブキーの下にデータを提供できません。SupportedTypes サブキーの詳細については、ファイルタイプ を参照してください。
-
アプリケーションの実行可能ファイルは、次の場所にある KillList 値にリストされていてはなりません。
HKEY_LOCAL_MACHINE Software Microsoft Windows CurrentVersion Explorer FileAssociation KillList注 サードパーティのアプリケーションは KillList 値を変更しないでください。これは読み取り専用と見なす必要があります。 -
アプリケーションの HKEY_CLASSES_ROOT\Applications 登録には、
<b>HKEY_CLASSES_ROOT</b>\<b>Applications</b>\<i>ExampleApp.exe</i>\<b>shell</b> サブキーの下に定義された一連の既定の動詞が必要です。SHAddToRecentDocs がタスクバーボタンへのドラッグアンドドロップの結果として登録を試みている場合、既存のアプリケーション登録に NoOpenWith 値が含まれておらず、かつアプリケーションの実行可能ファイルが KillList 値にリストされていない限り、shell サブキーがまだ存在しなければ作成されます。
SHAddToRecentDocs の呼び出しの抑制
Windows 7 より前のバージョンの Windows では、ファイルタイプは FTA_NoRecentDocs フラグを設定して、そのファイルタイプが Recent フォルダーに追加されないようにすることができました。このメカニズムは Windows 7 以降でもサポートされています。詳細については、ファイルタイプ を参照してください。SHAddToRecentDocs は、ドキュメントにアクセスするために呼び出される動詞を通じて、ドキュメントの使用統計を追跡します。登録された IContextMenu ハンドラーによって提供される動詞が追跡され、それらの項目は 最近使ったファイル (Windows XP) および 最近使った項目 (Windows Vista) に表示されます。Windows 7 では、ドキュメントの親フォルダーが Windows エクスプローラーのタスクバーボタンのジャンプリストに表示されます。ただし、それらの IContextMenu 動詞を通じてアクセスされたドキュメントは、アプリケーションのジャンプリストには表示されません。それらの項目をアプリケーションのジャンプリストに表示するには、アプリケーションが明示的に SHAddToRecentDocs を呼び出す必要があります。
Windows 7 より前では、open 動詞のみが SHAddToRecentDocs の呼び出しをもたらしました。Windows 7 以降では、他の動詞も使用統計を生成できます。この情報は、ジャンプリストの宛先をより完全で正確にするために使用されます。
ただし、一部のクラスのファイルタイプ関連付け登録、または個々の IContextMenu 実装は、この種の追跡には適していません。使用状況の追跡の目的は、ユーザーが再びアクセスしたいと思われる項目のリストを生成することです。特定の動詞 (たとえば delete) が、ユーザーが二度とアクセスしない項目に対して本質的に呼び出される場合、またはファイルのウイルススキャンのような二次的なアクションである場合、その動詞は追跡には適していません。ファイルタイプクラスは、レジストリエントリ NoRecentDocs を通じて、この追跡から自身を除外する必要があります。NoRecentDocs は REG_SZ 型であり、関連付けられたデータはありません。その存在のみが、SHAddToRecentDocs の呼び出しを防ぐために必要です。
たとえば、"*"、"AllFileSystemObjects"、"Folder" などのクラスの HKEY_CLASSES_ROOT の下に登録されたコンテキストメニュー拡張や静的動詞は追跡されるべきではありません。このような場合、ここに示すように、そのクラスに登録された任意の動詞または拡張を通じて起動されたドキュメントの追跡を抑制するために、NoRecentDocs エントリがクラスキーのルートに追加されます。
HKEY_CLASSES_ROOT
AllFileSystemObjects
NoRecentDocs
NoRecentDocs エントリは、既定で *、AllFileSystemObjects、Folder、Directory、および DesktopBackground クラスのサブキーに割り当てられます。
個々の IContextMenu 実装は、ここに示すように、その Component Object Model (COM) オブジェクトの登録の shellex サブキーの下に NoRecentDocs サブキーを追加することで、追跡をオプトアウトできます。
HKEY_CLASSES_ROOT
CLSID
{093C7AAB-5E72-454f-A91D-CA1BC991FCEC}
shellex
NoRecentDocs
このサブキーは、既定ではどの IContextMenu 実装にも存在しません。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHELL32.dll
#include <windows.h>
void SHAddToRecentDocs(
DWORD uFlags,
const void* pv // optional
);[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern void SHAddToRecentDocs(
uint uFlags, // DWORD
IntPtr pv // void* optional
);<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Sub SHAddToRecentDocs(
uFlags As UInteger, ' DWORD
pv As IntPtr ' void* optional
)
End Sub' uFlags : DWORD
' pv : void* optional
Declare PtrSafe Sub SHAddToRecentDocs Lib "shell32" ( _
ByVal uFlags As Long, _
ByVal pv As LongPtr)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SHAddToRecentDocs = ctypes.windll.shell32.SHAddToRecentDocs
SHAddToRecentDocs.restype = None
SHAddToRecentDocs.argtypes = [
wintypes.DWORD, # uFlags : DWORD
ctypes.POINTER(None), # pv : void* optional
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHELL32.dll')
SHAddToRecentDocs = Fiddle::Function.new(
lib['SHAddToRecentDocs'],
[
-Fiddle::TYPE_INT, # uFlags : DWORD
Fiddle::TYPE_VOIDP, # pv : void* optional
],
Fiddle::TYPE_VOID)#[link(name = "shell32")]
extern "system" {
fn SHAddToRecentDocs(
uFlags: u32, // DWORD
pv: *const () // void* optional
);
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("SHELL32.dll")]
public static extern void SHAddToRecentDocs(uint uFlags, IntPtr pv);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHAddToRecentDocs' -Namespace Win32 -PassThru
# $api::SHAddToRecentDocs(uFlags, pv)#uselib "SHELL32.dll"
#func global SHAddToRecentDocs "SHAddToRecentDocs" sptr, sptr
; SHAddToRecentDocs uFlags, pv
; uFlags : DWORD -> "sptr"
; pv : void* optional -> "sptr"#uselib "SHELL32.dll"
#func global SHAddToRecentDocs "SHAddToRecentDocs" int, sptr
; SHAddToRecentDocs uFlags, pv
; uFlags : DWORD -> "int"
; pv : void* optional -> "sptr"; void SHAddToRecentDocs(DWORD uFlags, void* pv)
#uselib "SHELL32.dll"
#func global SHAddToRecentDocs "SHAddToRecentDocs" int, intptr
; SHAddToRecentDocs uFlags, pv
; uFlags : DWORD -> "int"
; pv : void* optional -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shell32 = windows.NewLazySystemDLL("SHELL32.dll")
procSHAddToRecentDocs = shell32.NewProc("SHAddToRecentDocs")
)
// uFlags (DWORD), pv (void* optional)
r1, _, err := procSHAddToRecentDocs.Call(
uintptr(uFlags),
uintptr(pv),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // voidprocedure SHAddToRecentDocs(
uFlags: DWORD; // DWORD
pv: Pointer // void* optional
); stdcall;
external 'SHELL32.dll' name 'SHAddToRecentDocs';result := DllCall("SHELL32\SHAddToRecentDocs"
, "UInt", uFlags ; DWORD
, "Ptr", pv ; void* optional
, "Int") ; return: void●SHAddToRecentDocs(uFlags, pv) = DLL("SHELL32.dll", "int SHAddToRecentDocs(dword, void*)")
# 呼び出し: SHAddToRecentDocs(uFlags, pv)
# uFlags : DWORD -> "dword"
# pv : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "shell32" fn SHAddToRecentDocs(
uFlags: u32, // DWORD
pv: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) void;proc SHAddToRecentDocs(
uFlags: uint32, # DWORD
pv: pointer # void* optional
) {.importc: "SHAddToRecentDocs", stdcall, dynlib: "SHELL32.dll".}pragma(lib, "shell32");
extern(Windows)
void SHAddToRecentDocs(
uint uFlags, // DWORD
void* pv // void* optional
);ccall((:SHAddToRecentDocs, "SHELL32.dll"), stdcall, Cvoid,
(UInt32, Ptr{Cvoid}),
uFlags, pv)
# uFlags : DWORD -> UInt32
# pv : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
void SHAddToRecentDocs(
uint32_t uFlags,
void* pv);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHAddToRecentDocs(uFlags, pv)
-- uFlags : DWORD
-- pv : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const SHAddToRecentDocs = lib.func('__stdcall', 'SHAddToRecentDocs', 'void', ['uint32_t', 'void *']);
// SHAddToRecentDocs(uFlags, pv)
// uFlags : DWORD -> 'uint32_t'
// pv : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHELL32.dll", {
SHAddToRecentDocs: { parameters: ["u32", "pointer"], result: "void" },
});
// lib.symbols.SHAddToRecentDocs(uFlags, pv)
// uFlags : DWORD -> "u32"
// pv : void* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
void SHAddToRecentDocs(
uint32_t uFlags,
void* pv);
C, "SHELL32.dll");
// $ffi->SHAddToRecentDocs(uFlags, pv);
// uFlags : DWORD
// pv : void* optional
// 構造体/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);
void SHAddToRecentDocs(
int uFlags, // DWORD
Pointer pv // void* optional
);
}@[Link("shell32")]
lib LibSHELL32
fun SHAddToRecentDocs = SHAddToRecentDocs(
uFlags : UInt32, # DWORD
pv : Void* # void* optional
) : Void
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SHAddToRecentDocsNative = Void Function(Uint32, Pointer<Void>);
typedef SHAddToRecentDocsDart = void Function(int, Pointer<Void>);
final SHAddToRecentDocs = DynamicLibrary.open('SHELL32.dll')
.lookupFunction<SHAddToRecentDocsNative, SHAddToRecentDocsDart>('SHAddToRecentDocs');
// uFlags : DWORD -> Uint32
// pv : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
procedure SHAddToRecentDocs(
uFlags: DWORD; // DWORD
pv: Pointer // void* optional
); stdcall;
external 'SHELL32.dll' name 'SHAddToRecentDocs';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SHAddToRecentDocs"
c_SHAddToRecentDocs :: Word32 -> Ptr () -> IO ()
-- uFlags : DWORD -> Word32
-- pv : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let shaddtorecentdocs =
foreign "SHAddToRecentDocs"
(uint32_t @-> (ptr void) @-> returning void)
(* uFlags : DWORD -> uint32_t *)
(* pv : void* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)
(cffi:defcfun ("SHAddToRecentDocs" shadd-to-recent-docs :convention :stdcall) :void
(u-flags :uint32) ; DWORD
(pv :pointer)) ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SHAddToRecentDocs = Win32::API::More->new('SHELL32',
'void SHAddToRecentDocs(DWORD uFlags, LPVOID pv)');
# my $ret = $SHAddToRecentDocs->Call($uFlags, $pv);
# uFlags : DWORD -> DWORD
# pv : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f SHGetFolderLocation — CSIDLで指定したフォルダーのPIDLを取得する。
- f SHGetFolderPathW — CSIDLで指定したフォルダーのパス(Unicode)を取得する。