ホーム › System.DataExchange › GetPriorityClipboardFormat

GetPriorityClipboardFormat

関数

優先順位リストから最初に利用可能なクリップボード形式を返す。

DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

INT GetPriorityClipboardFormat(
    DWORD* paFormatPriorityList,
    INT cFormats
);

パラメーター

名前	型	方向	説明
paFormatPriorityList	DWORD*	in	優先順位順に並べたクリップボード形式。標準クリップボード形式の説明については、Standard Clipboard Formats を参照してください。
cFormats	INT	in	paFormatPriorityList 配列内のエントリ数。この値はリスト内のエントリ数を超えてはなりません。

戻り値の型: INT

公式ドキュメント

指定したリスト内で最初に利用可能なクリップボード形式を取得します。

戻り値

型: int

関数が成功した場合、戻り値はリスト内でデータが利用可能な最初のクリップボード形式です。クリップボードが空の場合、戻り値は NULL です。クリップボードにデータが存在するものの、指定したいずれの形式でもない場合、戻り値は –1 です。拡張エラー情報を取得するには、GetLastError を呼び出してください。

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

各言語での呼び出し定義

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

INT GetPriorityClipboardFormat(
    DWORD* paFormatPriorityList,
    INT cFormats
);

[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern int GetPriorityClipboardFormat(
    ref uint paFormatPriorityList,   // DWORD*
    int cFormats   // INT
);

<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetPriorityClipboardFormat(
    ByRef paFormatPriorityList As UInteger,   ' DWORD*
    cFormats As Integer   ' INT
) As Integer
End Function

' paFormatPriorityList : DWORD*
' cFormats : INT
Declare PtrSafe Function GetPriorityClipboardFormat Lib "user32" ( _
    ByRef paFormatPriorityList As Long, _
    ByVal cFormats As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetPriorityClipboardFormat = ctypes.windll.user32.GetPriorityClipboardFormat
GetPriorityClipboardFormat.restype = ctypes.c_int
GetPriorityClipboardFormat.argtypes = [
    ctypes.POINTER(wintypes.DWORD),  # paFormatPriorityList : DWORD*
    ctypes.c_int,  # cFormats : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetPriorityClipboardFormat = Fiddle::Function.new(
  lib['GetPriorityClipboardFormat'],
  [
    Fiddle::TYPE_VOIDP,  # paFormatPriorityList : DWORD*
    Fiddle::TYPE_INT,  # cFormats : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn GetPriorityClipboardFormat(
        paFormatPriorityList: *mut u32,  // DWORD*
        cFormats: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll", SetLastError = true)]
public static extern int GetPriorityClipboardFormat(ref uint paFormatPriorityList, int cFormats);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetPriorityClipboardFormat' -Namespace Win32 -PassThru
# $api::GetPriorityClipboardFormat(paFormatPriorityList, cFormats)

#uselib "USER32.dll"
#func global GetPriorityClipboardFormat "GetPriorityClipboardFormat" sptr, sptr
; GetPriorityClipboardFormat varptr(paFormatPriorityList), cFormats   ; 戻り値は stat
; paFormatPriorityList : DWORD* -> "sptr"
; cFormats : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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