Win32 API 日本語リファレンス
ホームSystem.DataExchange › GetUpdatedClipboardFormats

GetUpdatedClipboardFormats

関数
現在クリップボードに存在する全データ形式の一覧を取得する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL GetUpdatedClipboardFormats(
    DWORD* lpuiFormats,
    DWORD cFormats,
    DWORD* pcFormatsOut
);

パラメーター

名前方向説明
lpuiFormatsDWORD*outクリップボード形式の配列です。標準クリップボード形式の説明については、標準クリップボード形式を参照してください。
cFormatsDWORDinlpuiFormats が指す配列のエントリ数です。
pcFormatsOutDWORD*outlpuiFormats が指す配列に実際に格納されたクリップボード形式の数です。

戻り値の型: BOOL

公式ドキュメント

現在サポートされているクリップボード形式を取得します。

戻り値

型: BOOL

成功した場合、この関数は TRUE を返します。それ以外の場合は FALSE を返します。詳細については GetLastError を呼び出してください。

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

各言語での呼び出し定義

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

BOOL GetUpdatedClipboardFormats(
    DWORD* lpuiFormats,
    DWORD cFormats,
    DWORD* pcFormatsOut
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetUpdatedClipboardFormats(
    out uint lpuiFormats,   // DWORD* out
    uint cFormats,   // DWORD
    out uint pcFormatsOut   // DWORD* out
);
<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetUpdatedClipboardFormats(
    <Out> ByRef lpuiFormats As UInteger,   ' DWORD* out
    cFormats As UInteger,   ' DWORD
    <Out> ByRef pcFormatsOut As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpuiFormats : DWORD* out
' cFormats : DWORD
' pcFormatsOut : DWORD* out
Declare PtrSafe Function GetUpdatedClipboardFormats Lib "user32" ( _
    ByRef lpuiFormats As Long, _
    ByVal cFormats As Long, _
    ByRef pcFormatsOut As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetUpdatedClipboardFormats = ctypes.windll.user32.GetUpdatedClipboardFormats
GetUpdatedClipboardFormats.restype = wintypes.BOOL
GetUpdatedClipboardFormats.argtypes = [
    ctypes.POINTER(wintypes.DWORD),  # lpuiFormats : DWORD* out
    wintypes.DWORD,  # cFormats : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcFormatsOut : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetUpdatedClipboardFormats = Fiddle::Function.new(
  lib['GetUpdatedClipboardFormats'],
  [
    Fiddle::TYPE_VOIDP,  # lpuiFormats : DWORD* out
    -Fiddle::TYPE_INT,  # cFormats : DWORD
    Fiddle::TYPE_VOIDP,  # pcFormatsOut : DWORD* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn GetUpdatedClipboardFormats(
        lpuiFormats: *mut u32,  // DWORD* out
        cFormats: u32,  // DWORD
        pcFormatsOut: *mut u32  // DWORD* out
    ) -> 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 GetUpdatedClipboardFormats(out uint lpuiFormats, uint cFormats, out uint pcFormatsOut);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetUpdatedClipboardFormats' -Namespace Win32 -PassThru
# $api::GetUpdatedClipboardFormats(lpuiFormats, cFormats, pcFormatsOut)
#uselib "USER32.dll"
#func global GetUpdatedClipboardFormats "GetUpdatedClipboardFormats" sptr, sptr, sptr
; GetUpdatedClipboardFormats varptr(lpuiFormats), cFormats, varptr(pcFormatsOut)   ; 戻り値は stat
; lpuiFormats : DWORD* out -> "sptr"
; cFormats : DWORD -> "sptr"
; pcFormatsOut : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USER32.dll"
#cfunc global GetUpdatedClipboardFormats "GetUpdatedClipboardFormats" var, int, var
; res = GetUpdatedClipboardFormats(lpuiFormats, cFormats, pcFormatsOut)
; lpuiFormats : DWORD* out -> "var"
; cFormats : DWORD -> "int"
; pcFormatsOut : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL GetUpdatedClipboardFormats(DWORD* lpuiFormats, DWORD cFormats, DWORD* pcFormatsOut)
#uselib "USER32.dll"
#cfunc global GetUpdatedClipboardFormats "GetUpdatedClipboardFormats" var, int, var
; res = GetUpdatedClipboardFormats(lpuiFormats, cFormats, pcFormatsOut)
; lpuiFormats : DWORD* out -> "var"
; cFormats : DWORD -> "int"
; pcFormatsOut : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetUpdatedClipboardFormats = user32.NewProc("GetUpdatedClipboardFormats")
)

// lpuiFormats (DWORD* out), cFormats (DWORD), pcFormatsOut (DWORD* out)
r1, _, err := procGetUpdatedClipboardFormats.Call(
	uintptr(lpuiFormats),
	uintptr(cFormats),
	uintptr(pcFormatsOut),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function GetUpdatedClipboardFormats(
  lpuiFormats: Pointer;   // DWORD* out
  cFormats: DWORD;   // DWORD
  pcFormatsOut: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'USER32.dll' name 'GetUpdatedClipboardFormats';
result := DllCall("USER32\GetUpdatedClipboardFormats"
    , "Ptr", lpuiFormats   ; DWORD* out
    , "UInt", cFormats   ; DWORD
    , "Ptr", pcFormatsOut   ; DWORD* out
    , "Int")   ; return: BOOL
●GetUpdatedClipboardFormats(lpuiFormats, cFormats, pcFormatsOut) = DLL("USER32.dll", "bool GetUpdatedClipboardFormats(void*, dword, void*)")
# 呼び出し: GetUpdatedClipboardFormats(lpuiFormats, cFormats, pcFormatsOut)
# lpuiFormats : DWORD* out -> "void*"
# cFormats : DWORD -> "dword"
# pcFormatsOut : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "user32" fn GetUpdatedClipboardFormats(
    lpuiFormats: [*c]u32, // DWORD* out
    cFormats: u32, // DWORD
    pcFormatsOut: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;
proc GetUpdatedClipboardFormats(
    lpuiFormats: ptr uint32,  # DWORD* out
    cFormats: uint32,  # DWORD
    pcFormatsOut: ptr uint32  # DWORD* out
): int32 {.importc: "GetUpdatedClipboardFormats", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
int GetUpdatedClipboardFormats(
    uint* lpuiFormats,   // DWORD* out
    uint cFormats,   // DWORD
    uint* pcFormatsOut   // DWORD* out
);
ccall((:GetUpdatedClipboardFormats, "USER32.dll"), stdcall, Int32,
      (Ptr{UInt32}, UInt32, Ptr{UInt32}),
      lpuiFormats, cFormats, pcFormatsOut)
# lpuiFormats : DWORD* out -> Ptr{UInt32}
# cFormats : DWORD -> UInt32
# pcFormatsOut : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetUpdatedClipboardFormats(
    uint32_t* lpuiFormats,
    uint32_t cFormats,
    uint32_t* pcFormatsOut);
]]
local user32 = ffi.load("user32")
-- user32.GetUpdatedClipboardFormats(lpuiFormats, cFormats, pcFormatsOut)
-- lpuiFormats : DWORD* out
-- cFormats : DWORD
-- pcFormatsOut : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const GetUpdatedClipboardFormats = lib.func('__stdcall', 'GetUpdatedClipboardFormats', 'int32_t', ['uint32_t *', 'uint32_t', 'uint32_t *']);
// GetUpdatedClipboardFormats(lpuiFormats, cFormats, pcFormatsOut)
// lpuiFormats : DWORD* out -> 'uint32_t *'
// cFormats : DWORD -> 'uint32_t'
// pcFormatsOut : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  GetUpdatedClipboardFormats: { parameters: ["pointer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.GetUpdatedClipboardFormats(lpuiFormats, cFormats, pcFormatsOut)
// lpuiFormats : DWORD* out -> "pointer"
// cFormats : DWORD -> "u32"
// pcFormatsOut : DWORD* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetUpdatedClipboardFormats(
    uint32_t* lpuiFormats,
    uint32_t cFormats,
    uint32_t* pcFormatsOut);
C, "USER32.dll");
// $ffi->GetUpdatedClipboardFormats(lpuiFormats, cFormats, pcFormatsOut);
// lpuiFormats : DWORD* out
// cFormats : DWORD
// pcFormatsOut : DWORD* out
// 構造体/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 GetUpdatedClipboardFormats(
        IntByReference lpuiFormats,   // DWORD* out
        int cFormats,   // DWORD
        IntByReference pcFormatsOut   // DWORD* out
    );
}
@[Link("user32")]
lib LibUSER32
  fun GetUpdatedClipboardFormats = GetUpdatedClipboardFormats(
    lpuiFormats : UInt32*,   # DWORD* out
    cFormats : UInt32,   # DWORD
    pcFormatsOut : UInt32*   # DWORD* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetUpdatedClipboardFormatsNative = Int32 Function(Pointer<Uint32>, Uint32, Pointer<Uint32>);
typedef GetUpdatedClipboardFormatsDart = int Function(Pointer<Uint32>, int, Pointer<Uint32>);
final GetUpdatedClipboardFormats = DynamicLibrary.open('USER32.dll')
    .lookupFunction<GetUpdatedClipboardFormatsNative, GetUpdatedClipboardFormatsDart>('GetUpdatedClipboardFormats');
// lpuiFormats : DWORD* out -> Pointer<Uint32>
// cFormats : DWORD -> Uint32
// pcFormatsOut : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetUpdatedClipboardFormats(
  lpuiFormats: Pointer;   // DWORD* out
  cFormats: DWORD;   // DWORD
  pcFormatsOut: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'USER32.dll' name 'GetUpdatedClipboardFormats';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetUpdatedClipboardFormats"
  c_GetUpdatedClipboardFormats :: Ptr Word32 -> Word32 -> Ptr Word32 -> IO CInt
-- lpuiFormats : DWORD* out -> Ptr Word32
-- cFormats : DWORD -> Word32
-- pcFormatsOut : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getupdatedclipboardformats =
  foreign "GetUpdatedClipboardFormats"
    ((ptr uint32_t) @-> uint32_t @-> (ptr uint32_t) @-> returning int32_t)
(* lpuiFormats : DWORD* out -> (ptr uint32_t) *)
(* cFormats : DWORD -> uint32_t *)
(* pcFormatsOut : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("GetUpdatedClipboardFormats" get-updated-clipboard-formats :convention :stdcall) :int32
  (lpui-formats :pointer)   ; DWORD* out
  (c-formats :uint32)   ; DWORD
  (pc-formats-out :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetUpdatedClipboardFormats = Win32::API::More->new('USER32',
    'BOOL GetUpdatedClipboardFormats(LPVOID lpuiFormats, DWORD cFormats, LPVOID pcFormatsOut)');
# my $ret = $GetUpdatedClipboardFormats->Call($lpuiFormats, $cFormats, $pcFormatsOut);
# lpuiFormats : DWORD* out -> LPVOID
# cFormats : DWORD -> DWORD
# pcFormatsOut : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。