ホーム › UI.Shell › SHCreateStdEnumFmtEtc

SHCreateStdEnumFmtEtc

関数

FORMATETC列挙子(IEnumFORMATETC)を生成する。

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

シグネチャ

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

HRESULT SHCreateStdEnumFmtEtc(
    DWORD cfmt,
    const FORMATETC* afmt,
    IEnumFORMATETC** ppenumFormatEtc
);

パラメーター

名前	型	方向	説明
cfmt	DWORD	in	afmt 配列内のエントリ数。
afmt	FORMATETC*	in	対象とするクリップボード形式を指定する FORMATETC 構造体の配列。
ppenumFormatEtc	IEnumFORMATETC**	out	この関数が正常に終了すると、IEnumFORMATETC インターフェイスポインターを受け取ります。失敗した場合は NULL を受け取ります。

戻り値の型: HRESULT

公式ドキュメント

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

戻り値

型: HRESULT

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

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

各言語での呼び出し定義

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

HRESULT SHCreateStdEnumFmtEtc(
    DWORD cfmt,
    const FORMATETC* afmt,
    IEnumFORMATETC** ppenumFormatEtc
);

[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHCreateStdEnumFmtEtc(
    uint cfmt,   // DWORD
    IntPtr afmt,   // FORMATETC*
    IntPtr ppenumFormatEtc   // IEnumFORMATETC** out
);

<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHCreateStdEnumFmtEtc(
    cfmt As UInteger,   ' DWORD
    afmt As IntPtr,   ' FORMATETC*
    ppenumFormatEtc As IntPtr   ' IEnumFORMATETC** out
) As Integer
End Function

' cfmt : DWORD
' afmt : FORMATETC*
' ppenumFormatEtc : IEnumFORMATETC** out
Declare PtrSafe Function SHCreateStdEnumFmtEtc Lib "shell32" ( _
    ByVal cfmt As Long, _
    ByVal afmt As LongPtr, _
    ByVal ppenumFormatEtc As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SHCreateStdEnumFmtEtc = ctypes.windll.shell32.SHCreateStdEnumFmtEtc
SHCreateStdEnumFmtEtc.restype = ctypes.c_int
SHCreateStdEnumFmtEtc.argtypes = [
    wintypes.DWORD,  # cfmt : DWORD
    ctypes.c_void_p,  # afmt : FORMATETC*
    ctypes.c_void_p,  # ppenumFormatEtc : IEnumFORMATETC** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHCreateStdEnumFmtEtc = Fiddle::Function.new(
  lib['SHCreateStdEnumFmtEtc'],
  [
    -Fiddle::TYPE_INT,  # cfmt : DWORD
    Fiddle::TYPE_VOIDP,  # afmt : FORMATETC*
    Fiddle::TYPE_VOIDP,  # ppenumFormatEtc : IEnumFORMATETC** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "shell32")]
extern "system" {
    fn SHCreateStdEnumFmtEtc(
        cfmt: u32,  // DWORD
        afmt: *const FORMATETC,  // FORMATETC*
        ppenumFormatEtc: *mut *mut core::ffi::c_void  // IEnumFORMATETC** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHELL32.dll")]
public static extern int SHCreateStdEnumFmtEtc(uint cfmt, IntPtr afmt, IntPtr ppenumFormatEtc);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHCreateStdEnumFmtEtc' -Namespace Win32 -PassThru
# $api::SHCreateStdEnumFmtEtc(cfmt, afmt, ppenumFormatEtc)

#uselib "SHELL32.dll"
#func global SHCreateStdEnumFmtEtc "SHCreateStdEnumFmtEtc" sptr, sptr, sptr
; SHCreateStdEnumFmtEtc cfmt, varptr(afmt), ppenumFormatEtc   ; 戻り値は stat
; cfmt : DWORD -> "sptr"
; afmt : FORMATETC* -> "sptr"
; ppenumFormatEtc : IEnumFORMATETC** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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