ホーム › System.DataExchange › IsClipboardFormatAvailable
IsClipboardFormatAvailable
関数指定したデータ形式がクリップボードに存在するか調べる。
シグネチャ
// USER32.dll
#include <windows.h>
BOOL IsClipboardFormatAvailable(
DWORD format
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| format | DWORD | in | 標準またはレジスタ済みのクリップボード形式です。標準のクリップボード形式の説明については、Standard Clipboard Formats を参照してください。 |
戻り値の型: BOOL
公式ドキュメント
クリップボードに指定した形式のデータが含まれているかどうかを判定します。
戻り値
型: BOOL
そのクリップボード形式が利用可能な場合、戻り値は 0 以外になります。
そのクリップボード形式が利用できない場合、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を呼び出します。
解説(Remarks)
通常、クリップボード形式を 1 つだけ認識するアプリケーションは、WM_INITMENU または WM_INITMENUPOPUP メッセージの処理時にこの関数を呼び出します。そのうえで、戻り値に応じて [貼り付け] メニュー項目を有効または無効にします。複数のクリップボード形式を認識するアプリケーションでは、この目的のために GetPriorityClipboardFormat 関数を使用してください。
例
例については、Pasting Information from the Clipboard を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// USER32.dll
#include <windows.h>
BOOL IsClipboardFormatAvailable(
DWORD format
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool IsClipboardFormatAvailable(
uint format // DWORD
);<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function IsClipboardFormatAvailable(
format As UInteger ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' format : DWORD
Declare PtrSafe Function IsClipboardFormatAvailable 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
IsClipboardFormatAvailable = ctypes.windll.user32.IsClipboardFormatAvailable
IsClipboardFormatAvailable.restype = wintypes.BOOL
IsClipboardFormatAvailable.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')
IsClipboardFormatAvailable = Fiddle::Function.new(
lib['IsClipboardFormatAvailable'],
[
-Fiddle::TYPE_INT, # format : DWORD
],
Fiddle::TYPE_INT)#[link(name = "user32")]
extern "system" {
fn IsClipboardFormatAvailable(
format: u32 // DWORD
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true)]
public static extern bool IsClipboardFormatAvailable(uint format);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_IsClipboardFormatAvailable' -Namespace Win32 -PassThru
# $api::IsClipboardFormatAvailable(format)#uselib "USER32.dll"
#func global IsClipboardFormatAvailable "IsClipboardFormatAvailable" sptr
; IsClipboardFormatAvailable format ; 戻り値は stat
; format : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "USER32.dll"
#cfunc global IsClipboardFormatAvailable "IsClipboardFormatAvailable" int
; res = IsClipboardFormatAvailable(format)
; format : DWORD -> "int"; BOOL IsClipboardFormatAvailable(DWORD format)
#uselib "USER32.dll"
#cfunc global IsClipboardFormatAvailable "IsClipboardFormatAvailable" int
; res = IsClipboardFormatAvailable(format)
; format : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
user32 = windows.NewLazySystemDLL("USER32.dll")
procIsClipboardFormatAvailable = user32.NewProc("IsClipboardFormatAvailable")
)
// format (DWORD)
r1, _, err := procIsClipboardFormatAvailable.Call(
uintptr(format),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction IsClipboardFormatAvailable(
format: DWORD // DWORD
): BOOL; stdcall;
external 'USER32.dll' name 'IsClipboardFormatAvailable';result := DllCall("USER32\IsClipboardFormatAvailable"
, "UInt", format ; DWORD
, "Int") ; return: BOOL●IsClipboardFormatAvailable(format) = DLL("USER32.dll", "bool IsClipboardFormatAvailable(dword)")
# 呼び出し: IsClipboardFormatAvailable(format)
# format : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "user32" fn IsClipboardFormatAvailable(
format: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;proc IsClipboardFormatAvailable(
format: uint32 # DWORD
): int32 {.importc: "IsClipboardFormatAvailable", stdcall, dynlib: "USER32.dll".}pragma(lib, "user32");
extern(Windows)
int IsClipboardFormatAvailable(
uint format // DWORD
);ccall((:IsClipboardFormatAvailable, "USER32.dll"), stdcall, Int32,
(UInt32,),
format)
# format : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t IsClipboardFormatAvailable(
uint32_t format);
]]
local user32 = ffi.load("user32")
-- user32.IsClipboardFormatAvailable(format)
-- format : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const IsClipboardFormatAvailable = lib.func('__stdcall', 'IsClipboardFormatAvailable', 'int32_t', ['uint32_t']);
// IsClipboardFormatAvailable(format)
// format : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("USER32.dll", {
IsClipboardFormatAvailable: { parameters: ["u32"], result: "i32" },
});
// lib.symbols.IsClipboardFormatAvailable(format)
// format : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t IsClipboardFormatAvailable(
uint32_t format);
C, "USER32.dll");
// $ffi->IsClipboardFormatAvailable(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);
boolean IsClipboardFormatAvailable(
int format // DWORD
);
}@[Link("user32")]
lib LibUSER32
fun IsClipboardFormatAvailable = IsClipboardFormatAvailable(
format : UInt32 # DWORD
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef IsClipboardFormatAvailableNative = Int32 Function(Uint32);
typedef IsClipboardFormatAvailableDart = int Function(int);
final IsClipboardFormatAvailable = DynamicLibrary.open('USER32.dll')
.lookupFunction<IsClipboardFormatAvailableNative, IsClipboardFormatAvailableDart>('IsClipboardFormatAvailable');
// format : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function IsClipboardFormatAvailable(
format: DWORD // DWORD
): BOOL; stdcall;
external 'USER32.dll' name 'IsClipboardFormatAvailable';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "IsClipboardFormatAvailable"
c_IsClipboardFormatAvailable :: Word32 -> IO CInt
-- format : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let isclipboardformatavailable =
foreign "IsClipboardFormatAvailable"
(uint32_t @-> returning int32_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 ("IsClipboardFormatAvailable" is-clipboard-format-available :convention :stdcall) :int32
(format :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $IsClipboardFormatAvailable = Win32::API::More->new('USER32',
'BOOL IsClipboardFormatAvailable(DWORD format)');
# my $ret = $IsClipboardFormatAvailable->Call($format);
# format : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f CountClipboardFormats — クリップボード上に現在存在するデータ形式の数を取得する。
- f EnumClipboardFormats — クリップボードで利用可能なデータ形式を順に列挙する。
- f GetPriorityClipboardFormat — 優先順位リストから最初に利用可能なクリップボード形式を返す。
- f RegisterClipboardFormatW — 新しいクリップボード形式を登録しIDを取得する(Unicode版)。