EnumClipboardFormats
関数シグネチャ
// USER32.dll
#include <windows.h>
DWORD EnumClipboardFormats(
DWORD format
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| format | DWORD | in | 利用可能であることがわかっているクリップボード形式。 クリップボード形式の列挙を開始するには、 format を 0 に設定します。format が 0 の場合、この関数は最初に利用可能なクリップボード形式を取得します。列挙中の以降の呼び出しでは、 format に前回の EnumClipboardFormats 呼び出しの結果を設定します。 |
戻り値の型: DWORD
公式ドキュメント
クリップボードで現在利用可能なデータ形式を列挙します。
戻り値
型: UINT
関数が成功した場合、戻り値は指定した形式の次に続くクリップボード形式、すなわち次に利用可能なクリップボード形式です。
関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。クリップボードが開かれていない場合、関数は失敗します。
列挙すべきクリップボード形式がこれ以上ない場合、戻り値は 0 です。この場合、 GetLastError 関数は値 ERROR_SUCCESS を返します。これにより、関数の失敗と列挙の終了を区別できます。
解説(Remarks)
形式を列挙する前に、クリップボードを開いておく必要があります。クリップボードを開くには OpenClipboard 関数を使用します。クリップボードが開かれていない場合、EnumClipboardFormats 関数は失敗します。
EnumClipboardFormats 関数は、形式がクリップボードに格納された順序で列挙します。情報をクリップボードにコピーする場合は、最も詳細なクリップボード形式から最も詳細でないクリップボード形式の順にクリップボードオブジェクトを追加します。クリップボードから情報を貼り付ける場合は、処理可能な最初のクリップボード形式を取得します。それが処理可能な最も詳細なクリップボード形式となります。
システムは特定のクリップボード形式に対して自動的な型変換を提供します。そのような形式の場合、この関数は指定された形式を列挙した後、その形式が変換可能な形式を列挙します。詳細については、標準クリップボード形式 および 合成クリップボード形式 を参照してください。
例
例については、クリップボードビューアの例 を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// USER32.dll
#include <windows.h>
DWORD EnumClipboardFormats(
DWORD format
);[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern uint EnumClipboardFormats(
uint format // DWORD
);<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EnumClipboardFormats(
format As UInteger ' DWORD
) As UInteger
End Function' format : DWORD
Declare PtrSafe Function EnumClipboardFormats Lib "user32" ( _
ByVal format As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
EnumClipboardFormats = ctypes.windll.user32.EnumClipboardFormats
EnumClipboardFormats.restype = wintypes.DWORD
EnumClipboardFormats.argtypes = [
wintypes.DWORD, # format : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('USER32.dll')
EnumClipboardFormats = Fiddle::Function.new(
lib['EnumClipboardFormats'],
[
-Fiddle::TYPE_INT, # format : DWORD
],
-Fiddle::TYPE_INT)#[link(name = "user32")]
extern "system" {
fn EnumClipboardFormats(
format: u32 // DWORD
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("USER32.dll", SetLastError = true)]
public static extern uint EnumClipboardFormats(uint format);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_EnumClipboardFormats' -Namespace Win32 -PassThru
# $api::EnumClipboardFormats(format)#uselib "USER32.dll"
#func global EnumClipboardFormats "EnumClipboardFormats" sptr
; EnumClipboardFormats format ; 戻り値は stat
; format : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "USER32.dll"
#cfunc global EnumClipboardFormats "EnumClipboardFormats" int
; res = EnumClipboardFormats(format)
; format : DWORD -> "int"; DWORD EnumClipboardFormats(DWORD format)
#uselib "USER32.dll"
#cfunc global EnumClipboardFormats "EnumClipboardFormats" int
; res = EnumClipboardFormats(format)
; format : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
user32 = windows.NewLazySystemDLL("USER32.dll")
procEnumClipboardFormats = user32.NewProc("EnumClipboardFormats")
)
// format (DWORD)
r1, _, err := procEnumClipboardFormats.Call(
uintptr(format),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction EnumClipboardFormats(
format: DWORD // DWORD
): DWORD; stdcall;
external 'USER32.dll' name 'EnumClipboardFormats';result := DllCall("USER32\EnumClipboardFormats"
, "UInt", format ; DWORD
, "UInt") ; return: DWORD●EnumClipboardFormats(format) = DLL("USER32.dll", "dword EnumClipboardFormats(dword)")
# 呼び出し: EnumClipboardFormats(format)
# format : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "user32" fn EnumClipboardFormats(
format: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;proc EnumClipboardFormats(
format: uint32 # DWORD
): uint32 {.importc: "EnumClipboardFormats", stdcall, dynlib: "USER32.dll".}pragma(lib, "user32");
extern(Windows)
uint EnumClipboardFormats(
uint format // DWORD
);ccall((:EnumClipboardFormats, "USER32.dll"), stdcall, UInt32,
(UInt32,),
format)
# format : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t EnumClipboardFormats(
uint32_t format);
]]
local user32 = ffi.load("user32")
-- user32.EnumClipboardFormats(format)
-- format : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const EnumClipboardFormats = lib.func('__stdcall', 'EnumClipboardFormats', 'uint32_t', ['uint32_t']);
// EnumClipboardFormats(format)
// format : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("USER32.dll", {
EnumClipboardFormats: { parameters: ["u32"], result: "u32" },
});
// lib.symbols.EnumClipboardFormats(format)
// format : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t EnumClipboardFormats(
uint32_t format);
C, "USER32.dll");
// $ffi->EnumClipboardFormats(format);
// format : DWORD
// 構造体/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 User32 extends StdCallLibrary {
User32 INSTANCE = Native.load("user32", User32.class);
int EnumClipboardFormats(
int format // DWORD
);
}@[Link("user32")]
lib LibUSER32
fun EnumClipboardFormats = EnumClipboardFormats(
format : UInt32 # DWORD
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef EnumClipboardFormatsNative = Uint32 Function(Uint32);
typedef EnumClipboardFormatsDart = int Function(int);
final EnumClipboardFormats = DynamicLibrary.open('USER32.dll')
.lookupFunction<EnumClipboardFormatsNative, EnumClipboardFormatsDart>('EnumClipboardFormats');
// format : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function EnumClipboardFormats(
format: DWORD // DWORD
): DWORD; stdcall;
external 'USER32.dll' name 'EnumClipboardFormats';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "EnumClipboardFormats"
c_EnumClipboardFormats :: Word32 -> IO Word32
-- format : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let enumclipboardformats =
foreign "EnumClipboardFormats"
(uint32_t @-> returning uint32_t)
(* format : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)
(cffi:defcfun ("EnumClipboardFormats" enum-clipboard-formats :convention :stdcall) :uint32
(format :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $EnumClipboardFormats = Win32::API::More->new('USER32',
'DWORD EnumClipboardFormats(DWORD format)');
# my $ret = $EnumClipboardFormats->Call($format);
# format : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f CountClipboardFormats — クリップボード上に現在存在するデータ形式の数を取得する。
- f OpenClipboard — クリップボードを開いて操作のためにアクセスを取得する。
- f RegisterClipboardFormatW — 新しいクリップボード形式を登録しIDを取得する(Unicode版)。