ホーム › System.DataExchange › GetClipboardFormatNameA

GetClipboardFormatNameA

関数

登録済みクリップボード形式の名前をANSI文字列で取得する。

DLLUSER32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// USER32.dll  (ANSI / -A)
#include <windows.h>

INT GetClipboardFormatNameA(
    DWORD format,
    LPSTR lpszFormatName,
    INT cchMaxCount
);

パラメーター

名前	型	方向	説明
format	DWORD	in	取得するフォーマットの種類。このパラメーターには、定義済みのクリップボードフォーマットを指定できません。
lpszFormatName	LPSTR	out	フォーマット名を受け取るバッファー。
cchMaxCount	INT	in	バッファーにコピーする文字列の最大長(文字数)。名前がこの制限を超える場合は切り詰められます。

戻り値の型: INT

公式ドキュメント

クリップボードから、指定された登録済みフォーマットの名前を取得します。この関数は名前を指定されたバッファーにコピーします。(ANSI)

戻り値

型: int

関数が成功した場合、戻り値はバッファーにコピーされた文字列の長さ(文字数)です。

関数が失敗した場合、戻り値は 0 となり、要求されたフォーマットが存在しないか、定義済みであることを示します。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

セキュリティに関する考慮事項

この関数を誤って使用すると、プログラムのセキュリティが損なわれる可能性があります。たとえば、lpszFormatName バッファーの適切なサイズを誤って計算すると、特にアプリケーションが ANSI 版と Unicode 版の両方で使用される場合に、バッファーオーバーフローを引き起こすことがあります。また、文字列が cchMaxCount パラメーターより長い場合は切り詰められ、情報の損失につながる可能性があることに注意してください。

例

例については、クリップボードビューアーの例を参照してください。

メモ

winuser.h ヘッダーは GetClipboardFormatName を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こすことがあります。詳細については、関数プロトタイプの規約を参照してください。

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

各言語での呼び出し定義

// USER32.dll  (ANSI / -A)
#include <windows.h>

INT GetClipboardFormatNameA(
    DWORD format,
    LPSTR lpszFormatName,
    INT cchMaxCount
);

[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern int GetClipboardFormatNameA(
    uint format,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszFormatName,   // LPSTR out
    int cchMaxCount   // INT
);

<DllImport("USER32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetClipboardFormatNameA(
    format As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpszFormatName As System.Text.StringBuilder,   ' LPSTR out
    cchMaxCount As Integer   ' INT
) As Integer
End Function

' format : DWORD
' lpszFormatName : LPSTR out
' cchMaxCount : INT
Declare PtrSafe Function GetClipboardFormatNameA Lib "user32" ( _
    ByVal format As Long, _
    ByVal lpszFormatName As String, _
    ByVal cchMaxCount As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetClipboardFormatNameA = ctypes.windll.user32.GetClipboardFormatNameA
GetClipboardFormatNameA.restype = ctypes.c_int
GetClipboardFormatNameA.argtypes = [
    wintypes.DWORD,  # format : DWORD
    wintypes.LPSTR,  # lpszFormatName : LPSTR out
    ctypes.c_int,  # cchMaxCount : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetClipboardFormatNameA = Fiddle::Function.new(
  lib['GetClipboardFormatNameA'],
  [
    -Fiddle::TYPE_INT,  # format : DWORD
    Fiddle::TYPE_VOIDP,  # lpszFormatName : LPSTR out
    Fiddle::TYPE_INT,  # cchMaxCount : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn GetClipboardFormatNameA(
        format: u32,  // DWORD
        lpszFormatName: *mut u8,  // LPSTR out
        cchMaxCount: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern int GetClipboardFormatNameA(uint format, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszFormatName, int cchMaxCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetClipboardFormatNameA' -Namespace Win32 -PassThru
# $api::GetClipboardFormatNameA(format, lpszFormatName, cchMaxCount)

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

出力引数:

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