ホーム › UI.Shell › SHGetAttributesFromDataObject

SHGetAttributesFromDataObject

関数

データオブジェクトからシェルアイテム属性を取得する。

DLLSHELL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT SHGetAttributesFromDataObject(
    IDataObject* pdo,   // optional
    DWORD dwAttributeMask,
    DWORD* pdwAttributes,   // optional
    DWORD* pcItems   // optional
);

パラメーター

名前	型	方向	説明
pdo	IDataObject*	inoptional	情報を取得する元となるデータオブジェクトです。
dwAttributeMask	DWORD	in	呼び出し元アプリケーションが取得したい情報の種類を示す、1 つ以上の SFGAO フラグです。
pdwAttributes	DWORD*	outoptional	DWORD 値へのポインターです。この関数が正常に返ると、要求された情報のうち pdo 内のすべての項目に共通する属性を示す、1 つ以上の SFGAO フラグを受け取ります。この情報が不要な場合、このポインターは NULL にすることができます。
pcItems	DWORD*	outoptional	UINT へのポインターです。この関数が正常に返ると、pdo が指すデータオブジェクト内の PIDL の数を受け取ります。この情報が不要な場合、このポインターは NULL にすることができます。

戻り値の型: HRESULT

公式ドキュメント

SHGetAttributesFromDataObject は変更されるか、利用できなくなる可能性があります。

戻り値

型: HRESULT

この関数は次のいずれかの値を返すことがあります。

戻り値	説明
S_OK	成功しました。
S_FALSE	オブジェクトがシステムデータオブジェクトではありません。この場合、pdwAttributes は 0 に設定されます。

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

各言語での呼び出し定義

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

HRESULT SHGetAttributesFromDataObject(
    IDataObject* pdo,   // optional
    DWORD dwAttributeMask,
    DWORD* pdwAttributes,   // optional
    DWORD* pcItems   // optional
);

[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHGetAttributesFromDataObject(
    IntPtr pdo,   // IDataObject* optional
    uint dwAttributeMask,   // DWORD
    IntPtr pdwAttributes,   // DWORD* optional, out
    IntPtr pcItems   // DWORD* optional, out
);

<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHGetAttributesFromDataObject(
    pdo As IntPtr,   ' IDataObject* optional
    dwAttributeMask As UInteger,   ' DWORD
    pdwAttributes As IntPtr,   ' DWORD* optional, out
    pcItems As IntPtr   ' DWORD* optional, out
) As Integer
End Function

' pdo : IDataObject* optional
' dwAttributeMask : DWORD
' pdwAttributes : DWORD* optional, out
' pcItems : DWORD* optional, out
Declare PtrSafe Function SHGetAttributesFromDataObject Lib "shell32" ( _
    ByVal pdo As LongPtr, _
    ByVal dwAttributeMask As Long, _
    ByVal pdwAttributes As LongPtr, _
    ByVal pcItems As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHGetAttributesFromDataObject = ctypes.windll.shell32.SHGetAttributesFromDataObject
SHGetAttributesFromDataObject.restype = ctypes.c_int
SHGetAttributesFromDataObject.argtypes = [
    ctypes.c_void_p,  # pdo : IDataObject* optional
    wintypes.DWORD,  # dwAttributeMask : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pdwAttributes : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcItems : DWORD* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHGetAttributesFromDataObject = Fiddle::Function.new(
  lib['SHGetAttributesFromDataObject'],
  [
    Fiddle::TYPE_VOIDP,  # pdo : IDataObject* optional
    -Fiddle::TYPE_INT,  # dwAttributeMask : DWORD
    Fiddle::TYPE_VOIDP,  # pdwAttributes : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # pcItems : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "shell32")]
extern "system" {
    fn SHGetAttributesFromDataObject(
        pdo: *mut core::ffi::c_void,  // IDataObject* optional
        dwAttributeMask: u32,  // DWORD
        pdwAttributes: *mut u32,  // DWORD* optional, out
        pcItems: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHELL32.dll")]
public static extern int SHGetAttributesFromDataObject(IntPtr pdo, uint dwAttributeMask, IntPtr pdwAttributes, IntPtr pcItems);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHGetAttributesFromDataObject' -Namespace Win32 -PassThru
# $api::SHGetAttributesFromDataObject(pdo, dwAttributeMask, pdwAttributes, pcItems)

#uselib "SHELL32.dll"
#func global SHGetAttributesFromDataObject "SHGetAttributesFromDataObject" sptr, sptr, sptr, sptr
; SHGetAttributesFromDataObject pdo, dwAttributeMask, varptr(pdwAttributes), varptr(pcItems)   ; 戻り値は stat
; pdo : IDataObject* optional -> "sptr"
; dwAttributeMask : DWORD -> "sptr"
; pdwAttributes : DWORD* optional, out -> "sptr"
; pcItems : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHELL32.dll"
#cfunc global SHGetAttributesFromDataObject "SHGetAttributesFromDataObject" sptr, int, var, var
; res = SHGetAttributesFromDataObject(pdo, dwAttributeMask, pdwAttributes, pcItems)
; pdo : IDataObject* optional -> "sptr"
; dwAttributeMask : DWORD -> "int"
; pdwAttributes : DWORD* optional, out -> "var"
; pcItems : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHELL32.dll"
#cfunc global SHGetAttributesFromDataObject "SHGetAttributesFromDataObject" sptr, int, sptr, sptr
; res = SHGetAttributesFromDataObject(pdo, dwAttributeMask, varptr(pdwAttributes), varptr(pcItems))
; pdo : IDataObject* optional -> "sptr"
; dwAttributeMask : DWORD -> "int"
; pdwAttributes : DWORD* optional, out -> "sptr"
; pcItems : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。