SHGetIconOverlayIndexW
関数シグネチャ
// SHELL32.dll (Unicode / -W)
#include <windows.h>
INT SHGetIconOverlayIndexW(
LPCWSTR pszIconPath, // optional
INT iIconIndex
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pszIconPath | LPCWSTR | inoptional | アイコンを含むファイルの完全修飾パスを格納した、最大長 MAX_PATH の null 終端文字列へのポインターです。 |
| iIconIndex | INT | in | pszIconPath が指すファイル内でのアイコンのインデックスです。標準のオーバーレイアイコンを要求するには、pszIconPath を NULL に設定し、iIconIndex を次のいずれかに設定します。 IDO_SHGIOI_SHARE (0x0FFFFFFF)共有フォルダーを示すオーバーレイアイコンです。 IDO_SHGIOI_LINK (0x0FFFFFFE)リンクされたフォルダーまたはファイルを示すオーバーレイアイコンです。 IDO_SHGIOI_SLOWFILE (0x0FFFFFFD)低速ファイルを示すオーバーレイアイコンです。 IDO_SHGIOI_DEFAULT (0x0FFFFFFC)Windows 7 以降。項目がセット内の既定であることを示すオーバーレイアイコンです。一例として既定のプリンターがあります。 - iIconIndex.IDO_SHGIOI_DEFAULT (0x0FFFFFFC)Windows 7 以降。項目がセット内の既定であることを示すオーバーレイアイコンです。一例として既定のプリンターがあります。 - iIconIndex.IDO_SHGIOI_LINK (0x0FFFFFFE)リンクされたフォルダーまたはファイルを示すオーバーレイアイコンです。 - iIconIndex.IDO_SHGIOI_SHARE (0x0FFFFFFF)共有フォルダーを示すオーバーレイアイコンです。 - iIconIndex.IDO_SHGIOI_SLOWFILE (0x0FFFFFFD)低速ファイルを示すオーバーレイアイコンです。 |
戻り値の型: INT
公式ドキュメント
システムイメージリスト内のオーバーレイアイコンのインデックスを返します。(Unicode)
戻り値
型: int
成功した場合はシステムイメージリスト内のオーバーレイアイコンのインデックスを返し、それ以外の場合は -1 を返します。
解説(Remarks)
アイコンオーバーレイはシステムイメージリストの一部です。これらには 2 つの識別子があります。1 つ目は、イメージリスト内の他のオーバーレイに対する相対的なオーバーレイを識別する、1 から始まるオーバーレイインデックスです。もう 1 つは、実際のイメージを識別するイメージインデックスです。これら 2 つのインデックスは、ImageList_SetOverlayImage でプライベートイメージリストにアイコンオーバーレイを追加する際に、それぞれ iOverlay パラメーターおよび iImage パラメーターに割り当てる値と同等です。SHGetIconOverlayIndex はオーバーレイインデックスを返します。オーバーレイインデックスを同等のイメージインデックスに変換するには、INDEXTOOVERLAYMASK を呼び出します。
shlobj_core.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SHGetIconOverlayIndex を定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーやランタイムエラーを引き起こす不整合につながる可能性があります。詳細については、関数プロトタイプの規則 を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHELL32.dll (Unicode / -W)
#include <windows.h>
INT SHGetIconOverlayIndexW(
LPCWSTR pszIconPath, // optional
INT iIconIndex
);[DllImport("SHELL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int SHGetIconOverlayIndexW(
[MarshalAs(UnmanagedType.LPWStr)] string pszIconPath, // LPCWSTR optional
int iIconIndex // INT
);<DllImport("SHELL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHGetIconOverlayIndexW(
<MarshalAs(UnmanagedType.LPWStr)> pszIconPath As String, ' LPCWSTR optional
iIconIndex As Integer ' INT
) As Integer
End Function' pszIconPath : LPCWSTR optional
' iIconIndex : INT
Declare PtrSafe Function SHGetIconOverlayIndexW Lib "shell32" ( _
ByVal pszIconPath As LongPtr, _
ByVal iIconIndex As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SHGetIconOverlayIndexW = ctypes.windll.shell32.SHGetIconOverlayIndexW
SHGetIconOverlayIndexW.restype = ctypes.c_int
SHGetIconOverlayIndexW.argtypes = [
wintypes.LPCWSTR, # pszIconPath : LPCWSTR optional
ctypes.c_int, # iIconIndex : INT
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHELL32.dll')
SHGetIconOverlayIndexW = Fiddle::Function.new(
lib['SHGetIconOverlayIndexW'],
[
Fiddle::TYPE_VOIDP, # pszIconPath : LPCWSTR optional
Fiddle::TYPE_INT, # iIconIndex : INT
],
Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "shell32")]
extern "system" {
fn SHGetIconOverlayIndexW(
pszIconPath: *const u16, // LPCWSTR optional
iIconIndex: i32 // INT
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode)]
public static extern int SHGetIconOverlayIndexW([MarshalAs(UnmanagedType.LPWStr)] string pszIconPath, int iIconIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHGetIconOverlayIndexW' -Namespace Win32 -PassThru
# $api::SHGetIconOverlayIndexW(pszIconPath, iIconIndex)#uselib "SHELL32.dll"
#func global SHGetIconOverlayIndexW "SHGetIconOverlayIndexW" wptr, wptr
; SHGetIconOverlayIndexW pszIconPath, iIconIndex ; 戻り値は stat
; pszIconPath : LPCWSTR optional -> "wptr"
; iIconIndex : INT -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "SHELL32.dll"
#cfunc global SHGetIconOverlayIndexW "SHGetIconOverlayIndexW" wstr, int
; res = SHGetIconOverlayIndexW(pszIconPath, iIconIndex)
; pszIconPath : LPCWSTR optional -> "wstr"
; iIconIndex : INT -> "int"; INT SHGetIconOverlayIndexW(LPCWSTR pszIconPath, INT iIconIndex)
#uselib "SHELL32.dll"
#cfunc global SHGetIconOverlayIndexW "SHGetIconOverlayIndexW" wstr, int
; res = SHGetIconOverlayIndexW(pszIconPath, iIconIndex)
; pszIconPath : LPCWSTR optional -> "wstr"
; iIconIndex : INT -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shell32 = windows.NewLazySystemDLL("SHELL32.dll")
procSHGetIconOverlayIndexW = shell32.NewProc("SHGetIconOverlayIndexW")
)
// pszIconPath (LPCWSTR optional), iIconIndex (INT)
r1, _, err := procSHGetIconOverlayIndexW.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszIconPath))),
uintptr(iIconIndex),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction SHGetIconOverlayIndexW(
pszIconPath: PWideChar; // LPCWSTR optional
iIconIndex: Integer // INT
): Integer; stdcall;
external 'SHELL32.dll' name 'SHGetIconOverlayIndexW';result := DllCall("SHELL32\SHGetIconOverlayIndexW"
, "WStr", pszIconPath ; LPCWSTR optional
, "Int", iIconIndex ; INT
, "Int") ; return: INT●SHGetIconOverlayIndexW(pszIconPath, iIconIndex) = DLL("SHELL32.dll", "int SHGetIconOverlayIndexW(char*, int)")
# 呼び出し: SHGetIconOverlayIndexW(pszIconPath, iIconIndex)
# pszIconPath : LPCWSTR optional -> "char*"
# iIconIndex : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "shell32" fn SHGetIconOverlayIndexW(
pszIconPath: [*c]const u16, // LPCWSTR optional
iIconIndex: i32 // INT
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc SHGetIconOverlayIndexW(
pszIconPath: WideCString, # LPCWSTR optional
iIconIndex: int32 # INT
): int32 {.importc: "SHGetIconOverlayIndexW", stdcall, dynlib: "SHELL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "shell32");
extern(Windows)
int SHGetIconOverlayIndexW(
const(wchar)* pszIconPath, // LPCWSTR optional
int iIconIndex // INT
);ccall((:SHGetIconOverlayIndexW, "SHELL32.dll"), stdcall, Int32,
(Cwstring, Int32),
pszIconPath, iIconIndex)
# pszIconPath : LPCWSTR optional -> Cwstring
# iIconIndex : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t SHGetIconOverlayIndexW(
const uint16_t* pszIconPath,
int32_t iIconIndex);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHGetIconOverlayIndexW(pszIconPath, iIconIndex)
-- pszIconPath : LPCWSTR optional
-- iIconIndex : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const SHGetIconOverlayIndexW = lib.func('__stdcall', 'SHGetIconOverlayIndexW', 'int32_t', ['str16', 'int32_t']);
// SHGetIconOverlayIndexW(pszIconPath, iIconIndex)
// pszIconPath : LPCWSTR optional -> 'str16'
// iIconIndex : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHELL32.dll", {
SHGetIconOverlayIndexW: { parameters: ["buffer", "i32"], result: "i32" },
});
// lib.symbols.SHGetIconOverlayIndexW(pszIconPath, iIconIndex)
// pszIconPath : LPCWSTR optional -> "buffer"
// iIconIndex : INT -> "i32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SHGetIconOverlayIndexW(
const uint16_t* pszIconPath,
int32_t iIconIndex);
C, "SHELL32.dll");
// $ffi->SHGetIconOverlayIndexW(pszIconPath, iIconIndex);
// pszIconPath : LPCWSTR optional
// iIconIndex : INT
// 構造体/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.UNICODE_OPTIONS);
int SHGetIconOverlayIndexW(
WString pszIconPath, // LPCWSTR optional
int iIconIndex // INT
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("shell32")]
lib LibSHELL32
fun SHGetIconOverlayIndexW = SHGetIconOverlayIndexW(
pszIconPath : UInt16*, # LPCWSTR optional
iIconIndex : Int32 # INT
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SHGetIconOverlayIndexWNative = Int32 Function(Pointer<Utf16>, Int32);
typedef SHGetIconOverlayIndexWDart = int Function(Pointer<Utf16>, int);
final SHGetIconOverlayIndexW = DynamicLibrary.open('SHELL32.dll')
.lookupFunction<SHGetIconOverlayIndexWNative, SHGetIconOverlayIndexWDart>('SHGetIconOverlayIndexW');
// pszIconPath : LPCWSTR optional -> Pointer<Utf16>
// iIconIndex : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SHGetIconOverlayIndexW(
pszIconPath: PWideChar; // LPCWSTR optional
iIconIndex: Integer // INT
): Integer; stdcall;
external 'SHELL32.dll' name 'SHGetIconOverlayIndexW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SHGetIconOverlayIndexW"
c_SHGetIconOverlayIndexW :: CWString -> Int32 -> IO Int32
-- pszIconPath : LPCWSTR optional -> CWString
-- iIconIndex : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let shgeticonoverlayindexw =
foreign "SHGetIconOverlayIndexW"
((ptr uint16_t) @-> int32_t @-> returning int32_t)
(* pszIconPath : LPCWSTR optional -> (ptr uint16_t) *)
(* iIconIndex : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)
(cffi:defcfun ("SHGetIconOverlayIndexW" shget-icon-overlay-index-w :convention :stdcall) :int32
(psz-icon-path (:string :encoding :utf-16le)) ; LPCWSTR optional
(i-icon-index :int32)) ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SHGetIconOverlayIndexW = Win32::API::More->new('SHELL32',
'int SHGetIconOverlayIndexW(LPCWSTR pszIconPath, int iIconIndex)');
# my $ret = $SHGetIconOverlayIndexW->Call($pszIconPath, $iIconIndex);
# pszIconPath : LPCWSTR optional -> LPCWSTR
# iIconIndex : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f SHGetIconOverlayIndexA (ANSI版) — 指定アイコンのオーバーレイインデックスを取得する(ANSI版)。