SHChangeUpdateImageIDList
構造体サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。
フィールド
| フィールド | 型 | サイズ | x64 | x86 | 説明 |
|---|---|---|---|---|---|
| cb | WORD | 2 | +0 | +0 | 構造体のサイズ (バイト単位)。 |
| iIconIndex | INT | 4 | +2 | +2 | szName で指定されたファイル内のアイコンの、0 から始まるインデックス。この値は IExtractIcon::GetIconLocation を呼び出し、piIndex が指す値を取得することで得られます。 |
| iCurIndex | INT | 4 | +6 | +6 | 更新対象のアイコンの、システムイメージリスト内における 0 から始まるインデックス。 |
| uFlags | DWORD | 4 | +10 | +10 | アイコンの属性を決定するフラグ。この値は IExtractIcon::GetIconLocation を呼び出し、pwFlags が指す値を取得することで得られます。次の 2 つのフラグが SHUpdateImage に関係します。 GIL_NOTFILENAME場所がファイル名とインデックスの組ではありません。その場所からアイコンを抽出することにした呼び出し側アプリケーションは、目的のアイコンイメージを取得するために、このオブジェクトの IExtractIcon::Extract メソッドを呼び出さなければなりません。 GIL_SIMULATEDOC呼び出し側アプリケーションは、指定されたアイコンを使用してドキュメントアイコンを作成する必要があります。 |
| dwProcessID | DWORD | 4 | +14 | +14 | イメージ更新を要求したプロセスのID。 |
| szName | WCHAR | 520 | +18 | +18 | アイコンを含むファイルの完全修飾パスを指定する、NULL 終端の Unicode 文字列。この値は IExtractIcon::GetIconLocation を呼び出し、szIconFile が指す値を取得することで得られます。 |
| cbZero | WORD | 2 | +538 | +538 | - dwProcessIDintType: DWORD SHCNE_UPDATEIMAGE 通知を送信するプロセスの識別子。 |
公式ドキュメント
[SHChangeUpdateImageIDList は、要件セクションに記載されているオペレーティングシステムで使用できます。以降のバージョンでは変更されたり、利用できなくなったりする可能性があります。]
SHUpdateImage のパラメーターとして使用される情報を ITEMIDLIST を模した形式で格納し、SHChangeNotify で使用できるようにします。
解説(Remarks)
この例では、SHChangeNotify が SHChangeUpdateImageIDList と SHChangeDWORDAsIDList を使用して SHUpdateImage 関数を模倣する方法を示します。
void MyUpdateImage(LPCWSTR pszHashItem, int iIndex, UINT uFlags, int iImageIndex)
{
SHChangeUpdateImageIDList rgPidl;
SHChangeDWORDAsIDList rgDWord;
int cchLen;
USHORT *pcb;
// パラメーターの検証: iImageIndex は有効なシステムイメージリストの値でなければなりません。
if (iImageIndex < 0)
{
return;
}
// パラメーターの検証: pszHashItem の長さは MAX_PATH を超えてはなりません
cchLen = lstrlenW(pszHashItem);
if (cchLen >= MAX_PATH)
{
return;
}
// SHChangeUpdateImageIDList を設定します
rgPidl.dwProcessID = GetCurrentProcessId();
rgPidl.iIconIndex = iIndex;
rgPidl.iCurIndex = iImageIndex;
rgPidl.uFlags = uFlags;
lstrcpynW(rgPidl.szName, pszHashItem, MAX_PATH);
pcb = &rgPidl.szName[cchLen+1];
// 最初の要素のサイズを設定します
rgPidl.cb = (USHORT)((BYTE*)pcb - (BYTE*)rgPidl);
// "ITEMIDLIST" を終端します
*pcb = 0;
// SHChangeDWORDAsIDList を設定します
rgDWord.cb = (USHORT)FIELD_OFFSET(SHChangeDWORDAsIDList, cbZero);
rgDWord.dwItem1 = iImageIndex;
rgDWord.dwItem2 = 0;
rgDWord.cbZero = 0;
// これでパラメーターは SHCNE_UPDATEIMAGE が受け取れる形式になりました
SHChangeNotify(SHCNE_UPDATEIMAGE, SHCNF_IDLIST, &rgDWord, &rgPidl);
}
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での定義
#include <windows.h>
// SHChangeUpdateImageIDList (x64 540 / x86 540 バイト)
#pragma pack(push, 1)
typedef struct SHChangeUpdateImageIDList {
WORD cb;
INT iIconIndex;
INT iCurIndex;
DWORD uFlags;
DWORD dwProcessID;
WCHAR szName[260];
WORD cbZero;
} SHChangeUpdateImageIDList;
#pragma pack(pop)using System;
using System.Runtime.InteropServices;
[StructLayout(LayoutKind.Sequential, Pack = 1, CharSet = CharSet.Unicode)]
public struct SHChangeUpdateImageIDList
{
public ushort cb;
public int iIconIndex;
public int iCurIndex;
public uint uFlags;
public uint dwProcessID;
[MarshalAs(UnmanagedType.ByValTStr, SizeConst = 260)] public string szName;
public ushort cbZero;
}Imports System.Runtime.InteropServices
<StructLayout(LayoutKind.Sequential, Pack:=1, CharSet:=CharSet.Unicode)>
Public Structure SHChangeUpdateImageIDList
Public cb As UShort
Public iIconIndex As Integer
Public iCurIndex As Integer
Public uFlags As UInteger
Public dwProcessID As UInteger
<MarshalAs(UnmanagedType.ByValTStr, SizeConst:=260)> Public szName As String
Public cbZero As UShort
End Structureimport ctypes
from ctypes import wintypes
class SHChangeUpdateImageIDList(ctypes.Structure):
_pack_ = 1
_fields_ = [
("cb", ctypes.c_ushort),
("iIconIndex", ctypes.c_int),
("iCurIndex", ctypes.c_int),
("uFlags", wintypes.DWORD),
("dwProcessID", wintypes.DWORD),
("szName", ctypes.c_wchar * 260),
("cbZero", ctypes.c_ushort),
]#[repr(C, packed(1))]
pub struct SHChangeUpdateImageIDList {
pub cb: u16,
pub iIconIndex: i32,
pub iCurIndex: i32,
pub uFlags: u32,
pub dwProcessID: u32,
pub szName: [u16; 260],
pub cbZero: u16,
}import "golang.org/x/sys/windows"
type SHChangeUpdateImageIDList struct {
cb uint16
iIconIndex int32
iCurIndex int32
uFlags uint32
dwProcessID uint32
szName [260]uint16
cbZero uint16
}type
SHChangeUpdateImageIDList = packed record
cb: Word;
iIconIndex: Integer;
iCurIndex: Integer;
uFlags: DWORD;
dwProcessID: DWORD;
szName: array[0..259] of WideChar;
cbZero: Word;
end;const SHChangeUpdateImageIDList = extern struct {
cb: u16,
iIconIndex: i32,
iCurIndex: i32,
uFlags: u32,
dwProcessID: u32,
szName: [260]u16,
cbZero: u16,
};type
SHChangeUpdateImageIDList {.packed.} = object
cb: uint16
iIconIndex: int32
iCurIndex: int32
uFlags: uint32
dwProcessID: uint32
szName: array[260, uint16]
cbZero: uint16align(1)
struct SHChangeUpdateImageIDList
{
ushort cb;
int iIconIndex;
int iCurIndex;
uint uFlags;
uint dwProcessID;
wchar[260] szName;
ushort cbZero;
}HSP用 定義
HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; SHChangeUpdateImageIDList サイズ: 540 バイト(x64)
dim st, 135 ; 4byte整数×135(構造体サイズ 540 / 4 切り上げ)
; cb : WORD (+0, 2byte) wpoke st,0,値 / 値 = wpeek(st,0)
; iIconIndex : INT (+2, 4byte) lpoke st,2,値 / 値 = lpeek(st,2)
; iCurIndex : INT (+6, 4byte) lpoke st,6,値 / 値 = lpeek(st,6)
; uFlags : DWORD (+10, 4byte) lpoke st,10,値 / 値 = lpeek(st,10)
; dwProcessID : DWORD (+14, 4byte) lpoke st,14,値 / 値 = lpeek(st,14)
; szName : WCHAR (+18, 520byte) varptr(st)+18 を基点に操作(520byte:入れ子/配列)
; cbZero : WORD (+538, 2byte) wpoke st,538,値 / 値 = wpeek(st,538)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global SHChangeUpdateImageIDList, pack=1
#field short cb
#field int iIconIndex
#field int iCurIndex
#field int uFlags
#field int dwProcessID
#field wchar szName 260
#field short cbZero
#endstruct
stdim st, SHChangeUpdateImageIDList ; NSTRUCT 変数を確保
st->cb = 100
mes "cb=" + st->cb