ホーム › System.DataExchange › RegisterClipboardFormatW
RegisterClipboardFormatW
関数新しいクリップボード形式を登録しIDを取得する(Unicode版)。
シグネチャ
// USER32.dll (Unicode / -W)
#include <windows.h>
DWORD RegisterClipboardFormatW(
LPCWSTR lpszFormat
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| lpszFormat | LPCWSTR | in | 新しい形式の名前。 |
戻り値の型: DWORD
公式ドキュメント
新しいクリップボード形式を登録します。登録した形式は、有効なクリップボード形式として使用できるようになります。(Unicode)
戻り値
型: UINT
関数が成功すると、登録されたクリップボード形式を識別する値が返されます。
関数が失敗すると、戻り値は 0 になります。詳細なエラー情報を取得するには、GetLastError を呼び出します。
解説(Remarks)
指定した名前の登録済み形式が既に存在する場合、新しい形式は登録されず、戻り値は既存の形式を識別します。これにより、複数のアプリケーションが同じ登録済みクリップボード形式を使用してデータをコピーおよび貼り付けできます。なお、形式名の比較は大文字と小文字を区別しません。
登録済みクリップボード形式は、0xC000 から 0xFFFF までの範囲の値で識別されます。
登録済みクリップボード形式をクリップボードに格納したりクリップボードから取得したりする場合は、 HGLOBAL 値の形式である必要があります。
例
例については、クリップボード形式の登録を参照してください。
メモ
winuser.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして RegisterClipboardFormat を定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存ではないコードと混在して使用すると、不一致が生じ、コンパイルエラーまたは実行時エラーの原因となる可能性があります。詳細については、関数プロトタイプの規約を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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 (Unicode / -W)
#include <windows.h>
DWORD RegisterClipboardFormatW(
LPCWSTR lpszFormat
);[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern uint RegisterClipboardFormatW(
[MarshalAs(UnmanagedType.LPWStr)] string lpszFormat // LPCWSTR
);<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function RegisterClipboardFormatW(
<MarshalAs(UnmanagedType.LPWStr)> lpszFormat As String ' LPCWSTR
) As UInteger
End Function' lpszFormat : LPCWSTR
Declare PtrSafe Function RegisterClipboardFormatW Lib "user32" ( _
ByVal lpszFormat As LongPtr) 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
RegisterClipboardFormatW = ctypes.windll.user32.RegisterClipboardFormatW
RegisterClipboardFormatW.restype = wintypes.DWORD
RegisterClipboardFormatW.argtypes = [
wintypes.LPCWSTR, # lpszFormat : LPCWSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('USER32.dll')
RegisterClipboardFormatW = Fiddle::Function.new(
lib['RegisterClipboardFormatW'],
[
Fiddle::TYPE_VOIDP, # lpszFormat : LPCWSTR
],
-Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "user32")]
extern "system" {
fn RegisterClipboardFormatW(
lpszFormat: *const u16 // LPCWSTR
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern uint RegisterClipboardFormatW([MarshalAs(UnmanagedType.LPWStr)] string lpszFormat);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_RegisterClipboardFormatW' -Namespace Win32 -PassThru
# $api::RegisterClipboardFormatW(lpszFormat)#uselib "USER32.dll"
#func global RegisterClipboardFormatW "RegisterClipboardFormatW" wptr
; RegisterClipboardFormatW lpszFormat ; 戻り値は stat
; lpszFormat : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "USER32.dll"
#cfunc global RegisterClipboardFormatW "RegisterClipboardFormatW" wstr
; res = RegisterClipboardFormatW(lpszFormat)
; lpszFormat : LPCWSTR -> "wstr"; DWORD RegisterClipboardFormatW(LPCWSTR lpszFormat)
#uselib "USER32.dll"
#cfunc global RegisterClipboardFormatW "RegisterClipboardFormatW" wstr
; res = RegisterClipboardFormatW(lpszFormat)
; lpszFormat : LPCWSTR -> "wstr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
user32 = windows.NewLazySystemDLL("USER32.dll")
procRegisterClipboardFormatW = user32.NewProc("RegisterClipboardFormatW")
)
// lpszFormat (LPCWSTR)
r1, _, err := procRegisterClipboardFormatW.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszFormat))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction RegisterClipboardFormatW(
lpszFormat: PWideChar // LPCWSTR
): DWORD; stdcall;
external 'USER32.dll' name 'RegisterClipboardFormatW';result := DllCall("USER32\RegisterClipboardFormatW"
, "WStr", lpszFormat ; LPCWSTR
, "UInt") ; return: DWORD●RegisterClipboardFormatW(lpszFormat) = DLL("USER32.dll", "dword RegisterClipboardFormatW(char*)")
# 呼び出し: RegisterClipboardFormatW(lpszFormat)
# lpszFormat : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "user32" fn RegisterClipboardFormatW(
lpszFormat: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc RegisterClipboardFormatW(
lpszFormat: WideCString # LPCWSTR
): uint32 {.importc: "RegisterClipboardFormatW", stdcall, dynlib: "USER32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "user32");
extern(Windows)
uint RegisterClipboardFormatW(
const(wchar)* lpszFormat // LPCWSTR
);ccall((:RegisterClipboardFormatW, "USER32.dll"), stdcall, UInt32,
(Cwstring,),
lpszFormat)
# lpszFormat : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
uint32_t RegisterClipboardFormatW(
const uint16_t* lpszFormat);
]]
local user32 = ffi.load("user32")
-- user32.RegisterClipboardFormatW(lpszFormat)
-- lpszFormat : LPCWSTR
-- 構造体/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 RegisterClipboardFormatW = lib.func('__stdcall', 'RegisterClipboardFormatW', 'uint32_t', ['str16']);
// RegisterClipboardFormatW(lpszFormat)
// lpszFormat : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("USER32.dll", {
RegisterClipboardFormatW: { parameters: ["buffer"], result: "u32" },
});
// lib.symbols.RegisterClipboardFormatW(lpszFormat)
// lpszFormat : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t RegisterClipboardFormatW(
const uint16_t* lpszFormat);
C, "USER32.dll");
// $ffi->RegisterClipboardFormatW(lpszFormat);
// lpszFormat : LPCWSTR
// 構造体/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 RegisterClipboardFormatW(
WString lpszFormat // LPCWSTR
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("user32")]
lib LibUSER32
fun RegisterClipboardFormatW = RegisterClipboardFormatW(
lpszFormat : UInt16* # LPCWSTR
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef RegisterClipboardFormatWNative = Uint32 Function(Pointer<Utf16>);
typedef RegisterClipboardFormatWDart = int Function(Pointer<Utf16>);
final RegisterClipboardFormatW = DynamicLibrary.open('USER32.dll')
.lookupFunction<RegisterClipboardFormatWNative, RegisterClipboardFormatWDart>('RegisterClipboardFormatW');
// lpszFormat : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function RegisterClipboardFormatW(
lpszFormat: PWideChar // LPCWSTR
): DWORD; stdcall;
external 'USER32.dll' name 'RegisterClipboardFormatW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "RegisterClipboardFormatW"
c_RegisterClipboardFormatW :: CWString -> IO Word32
-- lpszFormat : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let registerclipboardformatw =
foreign "RegisterClipboardFormatW"
((ptr uint16_t) @-> returning uint32_t)
(* lpszFormat : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)
(cffi:defcfun ("RegisterClipboardFormatW" register-clipboard-format-w :convention :stdcall) :uint32
(lpsz-format (:string :encoding :utf-16le))) ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $RegisterClipboardFormatW = Win32::API::More->new('USER32',
'DWORD RegisterClipboardFormatW(LPCWSTR lpszFormat)');
# my $ret = $RegisterClipboardFormatW->Call($lpszFormat);
# lpszFormat : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
文字セット違い
- f RegisterClipboardFormatA (ANSI版) — 新しいクリップボード形式を登録しIDを取得する(ANSI版)。
公式の関連項目
- f CountClipboardFormats — クリップボード上に現在存在するデータ形式の数を取得する。
- f EnumClipboardFormats — クリップボードで利用可能なデータ形式を順に列挙する。
- f GetClipboardFormatNameW — 登録済みクリップボード形式の名前をUnicode文字列で取得する。