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

OLEUIPASTEENTRYW

構造体
サイズx64: 56 バイト / x86: 36 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
fmtetcFORMATETC32/20+0+0受け入れ可能な形式です。[形式を選択して貼り付け] ダイアログボックスは、この形式がクリップボード上のオブジェクトによって提供されているかどうかを確認し、提供されている場合はユーザーが選択できるように表示します。
lpstrFormatNameLPWSTR8/4+32+20ユーザーに対して形式を表す文字列へのポインターです。この文字列内の %s は、クリップボード上のオブジェクトの FullUserTypeName に置き換えられ、その結果の文字列がダイアログボックスのリストボックスに配置されます。%s は 1 つだけ使用できます。%s の有無により、結果テキストがデータの貼り付けを示すのか、アプリケーションによってアクティブ化できるオブジェクトの貼り付けを示すのかが決まります。%s が存在する場合、結果テキストはオブジェクトが貼り付けられることを示します。存在しない場合は、データが貼り付けられることを示します。
lpstrResultTextLPWSTR8/4+40+24ユーザーがこのエントリに対応する形式を選択したときに、ダイアログボックスの結果テキストをカスタマイズするために使用される文字列へのポインターです。この文字列内の %s は、アプリケーション名またはクリップボード上のオブジェクトの FullUserTypeName に置き換えられます。%s は 1 つだけ使用できます。
dwFlagsDWORD4+48+28OLEUIPASTEFLAG 列挙型の値です。
dwScratchSpaceDWORD4+52+32IEnumFORMATETC をループ処理して PasteEntry 形式が利用可能かどうかをマークするルーチンが使用できる作業用領域です。このフィールドは初期化しないままでもかまいません。

公式ドキュメント

[形式を選択して貼り付け] ダイアログボックス用に OLEUIPASTESPECIAL 構造体で指定するエントリの配列です。各エントリには、受け入れ可能な形式を指定する FORMATETC 構造体、ダイアログボックスのリストボックスでその形式を表す文字列、ダイアログボックスの結果テキストをカスタマイズするための文字列、および OLEUIPASTEFLAG 列挙型のフラグのセットが含まれます。これらのフラグは、そのエントリが貼り付けのみに有効か、リンクのみに有効か、あるいはその両方に有効かを示します。エントリがリンクに有効な場合、適切な OLEUIPASTE_LINKTYPEn 値をビット単位のOR で組み合わせることにより、どのリンク型が受け入れ可能かをフラグで示します。

解説(Remarks)

メモ

oledlg.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして OLEUIPASTEENTRY を定義しています。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在させて使用すると、不一致が生じてコンパイルエラーや実行時エラーの原因となる可能性があります。詳細については、「Conventions for Function Prototypes」を参照してください。

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

各言語での定義

#include <windows.h>

// FORMATETC  (x64 32 / x86 20 バイト)
typedef struct FORMATETC {
    WORD cfFormat;
    DVTARGETDEVICE* ptd;
    DWORD dwAspect;
    INT lindex;
    DWORD tymed;
} FORMATETC;

// OLEUIPASTEENTRYW  (x64 56 / x86 36 バイト)
typedef struct OLEUIPASTEENTRYW {
    FORMATETC fmtetc;
    LPWSTR lpstrFormatName;
    LPWSTR lpstrResultText;
    DWORD dwFlags;
    DWORD dwScratchSpace;
} OLEUIPASTEENTRYW;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct FORMATETC
{
    public ushort cfFormat;
    public IntPtr ptd;
    public uint dwAspect;
    public int lindex;
    public uint tymed;
}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct OLEUIPASTEENTRYW
{
    public FORMATETC fmtetc;
    public IntPtr lpstrFormatName;
    public IntPtr lpstrResultText;
    public uint dwFlags;
    public uint dwScratchSpace;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure FORMATETC
    Public cfFormat As UShort
    Public ptd As IntPtr
    Public dwAspect As UInteger
    Public lindex As Integer
    Public tymed As UInteger
End Structure

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure OLEUIPASTEENTRYW
    Public fmtetc As FORMATETC
    Public lpstrFormatName As IntPtr
    Public lpstrResultText As IntPtr
    Public dwFlags As UInteger
    Public dwScratchSpace As UInteger
End Structure
import ctypes
from ctypes import wintypes

class FORMATETC(ctypes.Structure):
    _fields_ = [
        ("cfFormat", ctypes.c_ushort),
        ("ptd", ctypes.c_void_p),
        ("dwAspect", wintypes.DWORD),
        ("lindex", ctypes.c_int),
        ("tymed", wintypes.DWORD),
    ]

class OLEUIPASTEENTRYW(ctypes.Structure):
    _fields_ = [
        ("fmtetc", FORMATETC),
        ("lpstrFormatName", ctypes.c_void_p),
        ("lpstrResultText", ctypes.c_void_p),
        ("dwFlags", wintypes.DWORD),
        ("dwScratchSpace", wintypes.DWORD),
    ]
#[repr(C)]
pub struct FORMATETC {
    pub cfFormat: u16,
    pub ptd: *mut core::ffi::c_void,
    pub dwAspect: u32,
    pub lindex: i32,
    pub tymed: u32,
}

#[repr(C)]
pub struct OLEUIPASTEENTRYW {
    pub fmtetc: FORMATETC,
    pub lpstrFormatName: *mut core::ffi::c_void,
    pub lpstrResultText: *mut core::ffi::c_void,
    pub dwFlags: u32,
    pub dwScratchSpace: u32,
}
import "golang.org/x/sys/windows"

type FORMATETC struct {
	cfFormat uint16
	ptd uintptr
	dwAspect uint32
	lindex int32
	tymed uint32
}

type OLEUIPASTEENTRYW struct {
	fmtetc FORMATETC
	lpstrFormatName uintptr
	lpstrResultText uintptr
	dwFlags uint32
	dwScratchSpace uint32
}
type
  FORMATETC = record
    cfFormat: Word;
    ptd: Pointer;
    dwAspect: DWORD;
    lindex: Integer;
    tymed: DWORD;
  end;

  OLEUIPASTEENTRYW = record
    fmtetc: FORMATETC;
    lpstrFormatName: Pointer;
    lpstrResultText: Pointer;
    dwFlags: DWORD;
    dwScratchSpace: DWORD;
  end;
const FORMATETC = extern struct {
    cfFormat: u16,
    ptd: ?*anyopaque,
    dwAspect: u32,
    lindex: i32,
    tymed: u32,
};

const OLEUIPASTEENTRYW = extern struct {
    fmtetc: FORMATETC,
    lpstrFormatName: ?*anyopaque,
    lpstrResultText: ?*anyopaque,
    dwFlags: u32,
    dwScratchSpace: u32,
};
type
  FORMATETC {.bycopy.} = object
    cfFormat: uint16
    ptd: pointer
    dwAspect: uint32
    lindex: int32
    tymed: uint32

  OLEUIPASTEENTRYW {.bycopy.} = object
    fmtetc: FORMATETC
    lpstrFormatName: pointer
    lpstrResultText: pointer
    dwFlags: uint32
    dwScratchSpace: uint32
struct FORMATETC
{
    ushort cfFormat;
    void* ptd;
    uint dwAspect;
    int lindex;
    uint tymed;
}

struct OLEUIPASTEENTRYW
{
    FORMATETC fmtetc;
    void* lpstrFormatName;
    void* lpstrResultText;
    uint dwFlags;
    uint dwScratchSpace;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; OLEUIPASTEENTRYW サイズ: 36 バイト(x86)
dim st, 9    ; 4byte整数×9(構造体サイズ 36 / 4 切り上げ)
; fmtetc : FORMATETC (+0, 20byte)  varptr(st)+0 を基点に操作(20byte:入れ子/配列)
; lpstrFormatName : LPWSTR (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; lpstrResultText : LPWSTR (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; dwFlags : DWORD (+28, 4byte)  st.7 = 値  /  値 = st.7   (lpoke/lpeek も可)
; dwScratchSpace : DWORD (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; OLEUIPASTEENTRYW サイズ: 56 バイト(x64)
dim st, 14    ; 4byte整数×14(構造体サイズ 56 / 4 切り上げ)
; fmtetc : FORMATETC (+0, 32byte)  varptr(st)+0 を基点に操作(32byte:入れ子/配列)
; lpstrFormatName : LPWSTR (+32, 8byte)  qpoke st,32,値 / qpeek(st,32)  ※IronHSPのみ。3.7/3.8は lpoke st,32,下位 : lpoke st,36,上位
; lpstrResultText : LPWSTR (+40, 8byte)  qpoke st,40,値 / qpeek(st,40)  ※IronHSPのみ。3.7/3.8は lpoke st,40,下位 : lpoke st,44,上位
; dwFlags : DWORD (+48, 4byte)  st.12 = 値  /  値 = st.12   (lpoke/lpeek も可)
; dwScratchSpace : DWORD (+52, 4byte)  st.13 = 値  /  値 = st.13   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#defstruct global FORMATETC
    #field short cfFormat
    #field intptr ptd
    #field int dwAspect
    #field int lindex
    #field int tymed
#endstruct

#defstruct global OLEUIPASTEENTRYW
    #field FORMATETC fmtetc
    #field intptr lpstrFormatName
    #field intptr lpstrResultText
    #field int dwFlags
    #field int dwScratchSpace
#endstruct

stdim st, OLEUIPASTEENTRYW        ; NSTRUCT 変数を確保
st->dwFlags = 100
mes "dwFlags=" + st->dwFlags