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

GetClipboardFormatNameW

関数
登録済みクリップボード形式の名前をUnicode文字列で取得する。
DLLUSER32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// USER32.dll  (Unicode / -W)
#include <windows.h>

INT GetClipboardFormatNameW(
    DWORD format,
    LPWSTR lpszFormatName,
    INT cchMaxCount
);

パラメーター

名前方向説明
formatDWORDin名前を取得する登録済みクリップボード形式の識別子。
lpszFormatNameLPWSTRout形式名(Unicode)を受け取るバッファ。
cchMaxCountINTinlpszFormatNameに格納できる最大文字数。

戻り値の型: INT

各言語での呼び出し定義

// USER32.dll  (Unicode / -W)
#include <windows.h>

INT GetClipboardFormatNameW(
    DWORD format,
    LPWSTR lpszFormatName,
    INT cchMaxCount
);
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern int GetClipboardFormatNameW(
    uint format,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszFormatName,   // LPWSTR out
    int cchMaxCount   // INT
);
<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetClipboardFormatNameW(
    format As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpszFormatName As System.Text.StringBuilder,   ' LPWSTR out
    cchMaxCount As Integer   ' INT
) As Integer
End Function
' format : DWORD
' lpszFormatName : LPWSTR out
' cchMaxCount : INT
Declare PtrSafe Function GetClipboardFormatNameW Lib "user32" ( _
    ByVal format As Long, _
    ByVal lpszFormatName As LongPtr, _
    ByVal cchMaxCount As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetClipboardFormatNameW = ctypes.windll.user32.GetClipboardFormatNameW
GetClipboardFormatNameW.restype = ctypes.c_int
GetClipboardFormatNameW.argtypes = [
    wintypes.DWORD,  # format : DWORD
    wintypes.LPWSTR,  # lpszFormatName : LPWSTR 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')
GetClipboardFormatNameW = Fiddle::Function.new(
  lib['GetClipboardFormatNameW'],
  [
    -Fiddle::TYPE_INT,  # format : DWORD
    Fiddle::TYPE_VOIDP,  # lpszFormatName : LPWSTR out
    Fiddle::TYPE_INT,  # cchMaxCount : INT
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "user32")]
extern "system" {
    fn GetClipboardFormatNameW(
        format: u32,  // DWORD
        lpszFormatName: *mut u16,  // LPWSTR out
        cchMaxCount: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern int GetClipboardFormatNameW(uint format, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszFormatName, int cchMaxCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetClipboardFormatNameW' -Namespace Win32 -PassThru
# $api::GetClipboardFormatNameW(format, lpszFormatName, cchMaxCount)
#uselib "USER32.dll"
#func global GetClipboardFormatNameW "GetClipboardFormatNameW" wptr, wptr, wptr
; GetClipboardFormatNameW format, varptr(lpszFormatName), cchMaxCount   ; 戻り値は stat
; format : DWORD -> "wptr"
; lpszFormatName : LPWSTR out -> "wptr"
; cchMaxCount : INT -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USER32.dll"
#cfunc global GetClipboardFormatNameW "GetClipboardFormatNameW" int, var, int
; res = GetClipboardFormatNameW(format, lpszFormatName, cchMaxCount)
; format : DWORD -> "int"
; lpszFormatName : LPWSTR out -> "var"
; cchMaxCount : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT GetClipboardFormatNameW(DWORD format, LPWSTR lpszFormatName, INT cchMaxCount)
#uselib "USER32.dll"
#cfunc global GetClipboardFormatNameW "GetClipboardFormatNameW" int, var, int
; res = GetClipboardFormatNameW(format, lpszFormatName, cchMaxCount)
; format : DWORD -> "int"
; lpszFormatName : LPWSTR out -> "var"
; cchMaxCount : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetClipboardFormatNameW = user32.NewProc("GetClipboardFormatNameW")
)

// format (DWORD), lpszFormatName (LPWSTR out), cchMaxCount (INT)
r1, _, err := procGetClipboardFormatNameW.Call(
	uintptr(format),
	uintptr(lpszFormatName),
	uintptr(cchMaxCount),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function GetClipboardFormatNameW(
  format: DWORD;   // DWORD
  lpszFormatName: PWideChar;   // LPWSTR out
  cchMaxCount: Integer   // INT
): Integer; stdcall;
  external 'USER32.dll' name 'GetClipboardFormatNameW';
result := DllCall("USER32\GetClipboardFormatNameW"
    , "UInt", format   ; DWORD
    , "Ptr", lpszFormatName   ; LPWSTR out
    , "Int", cchMaxCount   ; INT
    , "Int")   ; return: INT
●GetClipboardFormatNameW(format, lpszFormatName, cchMaxCount) = DLL("USER32.dll", "int GetClipboardFormatNameW(dword, char*, int)")
# 呼び出し: GetClipboardFormatNameW(format, lpszFormatName, cchMaxCount)
# format : DWORD -> "dword"
# lpszFormatName : LPWSTR out -> "char*"
# cchMaxCount : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "user32" fn GetClipboardFormatNameW(
    format: u32, // DWORD
    lpszFormatName: [*c]u16, // LPWSTR out
    cchMaxCount: i32 // INT
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc GetClipboardFormatNameW(
    format: uint32,  # DWORD
    lpszFormatName: ptr uint16,  # LPWSTR out
    cchMaxCount: int32  # INT
): int32 {.importc: "GetClipboardFormatNameW", stdcall, dynlib: "USER32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "user32");
extern(Windows)
int GetClipboardFormatNameW(
    uint format,   // DWORD
    wchar* lpszFormatName,   // LPWSTR out
    int cchMaxCount   // INT
);
ccall((:GetClipboardFormatNameW, "USER32.dll"), stdcall, Int32,
      (UInt32, Ptr{UInt16}, Int32),
      format, lpszFormatName, cchMaxCount)
# format : DWORD -> UInt32
# lpszFormatName : LPWSTR out -> Ptr{UInt16}
# cchMaxCount : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetClipboardFormatNameW(
    uint32_t format,
    uint16_t* lpszFormatName,
    int32_t cchMaxCount);
]]
local user32 = ffi.load("user32")
-- user32.GetClipboardFormatNameW(format, lpszFormatName, cchMaxCount)
-- format : DWORD
-- lpszFormatName : LPWSTR out
-- cchMaxCount : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const GetClipboardFormatNameW = lib.func('__stdcall', 'GetClipboardFormatNameW', 'int32_t', ['uint32_t', 'uint16_t *', 'int32_t']);
// GetClipboardFormatNameW(format, lpszFormatName, cchMaxCount)
// format : DWORD -> 'uint32_t'
// lpszFormatName : LPWSTR out -> 'uint16_t *'
// cchMaxCount : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  GetClipboardFormatNameW: { parameters: ["u32", "buffer", "i32"], result: "i32" },
});
// lib.symbols.GetClipboardFormatNameW(format, lpszFormatName, cchMaxCount)
// format : DWORD -> "u32"
// lpszFormatName : LPWSTR out -> "buffer"
// cchMaxCount : INT -> "i32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetClipboardFormatNameW(
    uint32_t format,
    uint16_t* lpszFormatName,
    int32_t cchMaxCount);
C, "USER32.dll");
// $ffi->GetClipboardFormatNameW(format, lpszFormatName, cchMaxCount);
// format : DWORD
// lpszFormatName : LPWSTR out
// cchMaxCount : INT
// 構造体/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, W32APIOptions.UNICODE_OPTIONS);
    int GetClipboardFormatNameW(
        int format,   // DWORD
        char[] lpszFormatName,   // LPWSTR out
        int cchMaxCount   // INT
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("user32")]
lib LibUSER32
  fun GetClipboardFormatNameW = GetClipboardFormatNameW(
    format : UInt32,   # DWORD
    lpszFormatName : UInt16*,   # LPWSTR out
    cchMaxCount : Int32   # INT
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetClipboardFormatNameWNative = Int32 Function(Uint32, Pointer<Utf16>, Int32);
typedef GetClipboardFormatNameWDart = int Function(int, Pointer<Utf16>, int);
final GetClipboardFormatNameW = DynamicLibrary.open('USER32.dll')
    .lookupFunction<GetClipboardFormatNameWNative, GetClipboardFormatNameWDart>('GetClipboardFormatNameW');
// format : DWORD -> Uint32
// lpszFormatName : LPWSTR out -> Pointer<Utf16>
// cchMaxCount : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetClipboardFormatNameW(
  format: DWORD;   // DWORD
  lpszFormatName: PWideChar;   // LPWSTR out
  cchMaxCount: Integer   // INT
): Integer; stdcall;
  external 'USER32.dll' name 'GetClipboardFormatNameW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetClipboardFormatNameW"
  c_GetClipboardFormatNameW :: Word32 -> CWString -> Int32 -> IO Int32
-- format : DWORD -> Word32
-- lpszFormatName : LPWSTR out -> CWString
-- cchMaxCount : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getclipboardformatnamew =
  foreign "GetClipboardFormatNameW"
    (uint32_t @-> (ptr uint16_t) @-> int32_t @-> returning int32_t)
(* format : DWORD -> uint32_t *)
(* lpszFormatName : LPWSTR out -> (ptr uint16_t) *)
(* cchMaxCount : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("GetClipboardFormatNameW" get-clipboard-format-name-w :convention :stdcall) :int32
  (format :uint32)   ; DWORD
  (lpsz-format-name :pointer)   ; LPWSTR out
  (cch-max-count :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetClipboardFormatNameW = Win32::API::More->new('USER32',
    'int GetClipboardFormatNameW(DWORD format, LPWSTR lpszFormatName, int cchMaxCount)');
# my $ret = $GetClipboardFormatNameW->Call($format, $lpszFormatName, $cchMaxCount);
# format : DWORD -> DWORD
# lpszFormatName : LPWSTR out -> LPWSTR
# cchMaxCount : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い