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

OleUIPasteSpecialA

関数
形式を選択して貼り付けるダイアログを表示する。ANSI版。
DLLoledlg.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD OleUIPasteSpecialA(
    OLEUIPASTESPECIALA* param0
);

パラメーター

名前方向説明
param0OLEUIPASTESPECIALA*in形式を選択して貼り付けダイアログを構成するOLEUIPASTESPECIALA構造体へのポインタ。

戻り値の型: DWORD

公式ドキュメント

標準の Paste Special(形式を選択して貼り付け)ダイアログ ボックスを表示し、貼り付けまたはリンク貼り付けするクリップボード オブジェクトの形式をユーザーが選択できるようにします。(ANSI)

戻り値

標準の成功 / エラー定義

戻り値 説明
OLEUI_FALSE
原因不明の失敗(未使用)。
OLEUI_OK
ユーザーが OK ボタンを押しました。
OLEUI_SUCCESS
エラーなし。OLEUI_OK と同じです。
OLEUI_CANCEL
ユーザーがキャンセル ボタンを押しました。

標準のフィールド検証エラー

戻り値 説明
OLEUI_ERR_STANDARDMIN
すべてのダイアログ ボックスに共通するエラーは、OLEUI_ERR_STANDARDMIN から OLEUI_ERR_STANDARDMAX の範囲に含まれます。この値により、アプリケーションは標準メッセージを判定し、ユーザーにエラー メッセージを表示できます。
OLEUI_ERR_STRUCTURENULL
関数に渡された OLEUIXXX 構造体へのポインターが NULL でした。
OLEUI_ERR_STRUCTUREINVALID
OLEUIXXX 構造体への読み取りまたは書き込みアクセスのアクセス許可が不足しています。
OLEUI_ERR_CBSTRUCTINCORRECT
cbstruct の値が正しくありません。
OLEUI_ERR_HWNDOWNERINVALID
hWndOwner の値が無効です。
OLEUI_ERR_LPSZCAPTIONINVALID
lpszCaption の値が無効です。
OLEUI_ERR_LPFNHOOKINVALID
lpfnHook の値が無効です。
OLEUI_ERR_HINSTANCEINVALID
hInstance の値が無効です。
OLEUI_ERR_LPSZTEMPLATEINVALID
lpszTemplate の値が無効です。
OLEUI_ERR_HRESOURCEINVALID
hResource の値が無効です。

初期化エラー

戻り値 説明
OLEUI_ERR_FINDTEMPLATEFAILURE
ダイアログ ボックス テンプレートが見つかりません。
OLEUI_ERR_LOADTEMPLATEFAILURE
ダイアログ ボックス テンプレートを読み込めません。
OLEUI_ERR_DIALOGFAILURE
ダイアログ ボックスの初期化に失敗しました。
OLEUI_ERR_LOCALMEMALLOC
LocalAlloc または標準の IMalloc アロケーターの呼び出しに失敗しました。
OLEUI_ERR_GLOBALMEMALLOC
GlobalAlloc または標準の IMalloc アロケーターの呼び出しに失敗しました。
OLEUI_ERR_LOADSTRING
ライブラリからローカライズされたリソースを取得するための LoadString を呼び出せません。
OLEUI_ERR_OLEMEMALLOC
標準の IMalloc アロケーターの呼び出しに失敗しました。

関数固有のエラー

戻り値 説明
OLEUI_ERR_STANDARDMAX
すべてのダイアログ ボックスに共通するエラーは、OLEUI_ERR_STANDARDMIN から OLEUI_ERR_STANDARDMAX の範囲に含まれます。この値により、アプリケーションは標準メッセージを判定し、ユーザーにエラー メッセージを表示できます。
OLEUI_IOERR_SRCDATAOBJECTINVALID
OLEUIPASTESPECIALlpSrcDataObject メンバーが無効です。
OLEUI_IOERR_ARRPASTEENTRIESINVALID
OLEUIPASTESPECIALarrPasteEntries メンバーが無効です。
OLEUI_IOERR_ARRLINKTYPESINVALID
OLEUIPASTESPECIALarrLinkTypes メンバーが無効です。
OLEUI_PSERR_CLIPBOARDCHANGED
ダイアログ ボックスの表示中にクリップボードの内容が変更されました。
OLEUI_PSERR_GETCLIPBOAARDFAILED

lpSrcDataObj メンバーが正しくありません。

解説(Remarks)

Paste Special ダイアログ ボックスの設計では、ユーザーにオブジェクトへのリンクを許可するのであれば、そのオブジェクトの埋め込みも許可するものと想定されています。このため、OLEUIPASTEFLAG 列挙体に関連付けられた OLEUIPASTE_LINKTYPE フラグのいずれかが設定されている場合、データ形式を Paste Special ダイアログ ボックスに表示するには、OLEUIPASTE_PASTE フラグも設定する必要があります。

Oledlg32.dll に実装されている標準の Paste Special ダイアログ ボックスの Source フィールドに表示されるテキストは、貼り付け対象オブジェクトの OBJECTDESCRIPTOR 構造体の dwSrcofCopy メンバーでバイト単位のオフセットが指定された、null 終端文字列です。このオブジェクトに OBJECTDESCRIPTOR 構造体が利用できない場合、ダイアログ ボックスは CF_LINKSOURCEDESCRIPTOR に関連付けられたテキストを表示します。どちらの構造体も利用できない場合、ダイアログ ボックスは CF_FILENAME を検索します。CF_FILENAME が見つからない場合、ダイアログ ボックスは文字列 "Unknown Source" を表示します。

Insert Object または Paste Special ダイアログ ボックスから返された HMETAFILEPICT を解放するには、次のようにハンドル上の付属するメタファイルを削除します。

void FreeHmetafilepict(HMETAFILEPICT hmfp)
{
    if (hmfp != NULL)
    {
        LPMETAFILEPICT pmfp = GlobalLock(hmfp);
 
        DeleteMetaFile(pmfp->hMF);
        GlobalUnlock(hmfp);
        GlobalFree(hmfp);
    }
    else
    {
        // Handle null pointers here.
        exit(0);
    }
}
メモ

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

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

各言語での呼び出し定義

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

DWORD OleUIPasteSpecialA(
    OLEUIPASTESPECIALA* param0
);
[DllImport("oledlg.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint OleUIPasteSpecialA(
    IntPtr param0   // OLEUIPASTESPECIALA*
);
<DllImport("oledlg.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function OleUIPasteSpecialA(
    param0 As IntPtr   ' OLEUIPASTESPECIALA*
) As UInteger
End Function
' param0 : OLEUIPASTESPECIALA*
Declare PtrSafe Function OleUIPasteSpecialA Lib "oledlg" ( _
    ByVal param0 As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

OleUIPasteSpecialA = ctypes.windll.oledlg.OleUIPasteSpecialA
OleUIPasteSpecialA.restype = wintypes.DWORD
OleUIPasteSpecialA.argtypes = [
    ctypes.c_void_p,  # param0 : OLEUIPASTESPECIALA*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('oledlg.dll')
OleUIPasteSpecialA = Fiddle::Function.new(
  lib['OleUIPasteSpecialA'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : OLEUIPASTESPECIALA*
  ],
  -Fiddle::TYPE_INT)
#[link(name = "oledlg")]
extern "system" {
    fn OleUIPasteSpecialA(
        param0: *mut OLEUIPASTESPECIALA  // OLEUIPASTESPECIALA*
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("oledlg.dll", CharSet = CharSet.Ansi)]
public static extern uint OleUIPasteSpecialA(IntPtr param0);
"@
$api = Add-Type -MemberDefinition $sig -Name 'oledlg_OleUIPasteSpecialA' -Namespace Win32 -PassThru
# $api::OleUIPasteSpecialA(param0)
#uselib "oledlg.dll"
#func global OleUIPasteSpecialA "OleUIPasteSpecialA" sptr
; OleUIPasteSpecialA varptr(param0)   ; 戻り値は stat
; param0 : OLEUIPASTESPECIALA* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "oledlg.dll"
#cfunc global OleUIPasteSpecialA "OleUIPasteSpecialA" var
; res = OleUIPasteSpecialA(param0)
; param0 : OLEUIPASTESPECIALA* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD OleUIPasteSpecialA(OLEUIPASTESPECIALA* param0)
#uselib "oledlg.dll"
#cfunc global OleUIPasteSpecialA "OleUIPasteSpecialA" var
; res = OleUIPasteSpecialA(param0)
; param0 : OLEUIPASTESPECIALA* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	oledlg = windows.NewLazySystemDLL("oledlg.dll")
	procOleUIPasteSpecialA = oledlg.NewProc("OleUIPasteSpecialA")
)

// param0 (OLEUIPASTESPECIALA*)
r1, _, err := procOleUIPasteSpecialA.Call(
	uintptr(param0),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function OleUIPasteSpecialA(
  param0: Pointer   // OLEUIPASTESPECIALA*
): DWORD; stdcall;
  external 'oledlg.dll' name 'OleUIPasteSpecialA';
result := DllCall("oledlg\OleUIPasteSpecialA"
    , "Ptr", param0   ; OLEUIPASTESPECIALA*
    , "UInt")   ; return: DWORD
●OleUIPasteSpecialA(param0) = DLL("oledlg.dll", "dword OleUIPasteSpecialA(void*)")
# 呼び出し: OleUIPasteSpecialA(param0)
# param0 : OLEUIPASTESPECIALA* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "oledlg" fn OleUIPasteSpecialA(
    param0: [*c]OLEUIPASTESPECIALA // OLEUIPASTESPECIALA*
) callconv(std.os.windows.WINAPI) u32;
proc OleUIPasteSpecialA(
    param0: ptr OLEUIPASTESPECIALA  # OLEUIPASTESPECIALA*
): uint32 {.importc: "OleUIPasteSpecialA", stdcall, dynlib: "oledlg.dll".}
pragma(lib, "oledlg");
extern(Windows)
uint OleUIPasteSpecialA(
    OLEUIPASTESPECIALA* param0   // OLEUIPASTESPECIALA*
);
ccall((:OleUIPasteSpecialA, "oledlg.dll"), stdcall, UInt32,
      (Ptr{OLEUIPASTESPECIALA},),
      param0)
# param0 : OLEUIPASTESPECIALA* -> Ptr{OLEUIPASTESPECIALA}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t OleUIPasteSpecialA(
    void* param0);
]]
local oledlg = ffi.load("oledlg")
-- oledlg.OleUIPasteSpecialA(param0)
-- param0 : OLEUIPASTESPECIALA*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('oledlg.dll');
const OleUIPasteSpecialA = lib.func('__stdcall', 'OleUIPasteSpecialA', 'uint32_t', ['void *']);
// OleUIPasteSpecialA(param0)
// param0 : OLEUIPASTESPECIALA* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("oledlg.dll", {
  OleUIPasteSpecialA: { parameters: ["pointer"], result: "u32" },
});
// lib.symbols.OleUIPasteSpecialA(param0)
// param0 : OLEUIPASTESPECIALA* -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t OleUIPasteSpecialA(
    void* param0);
C, "oledlg.dll");
// $ffi->OleUIPasteSpecialA(param0);
// param0 : OLEUIPASTESPECIALA*
// 構造体/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 Oledlg extends StdCallLibrary {
    Oledlg INSTANCE = Native.load("oledlg", Oledlg.class, W32APIOptions.ASCII_OPTIONS);
    int OleUIPasteSpecialA(
        Pointer param0   // OLEUIPASTESPECIALA*
    );
}
@[Link("oledlg")]
lib Liboledlg
  fun OleUIPasteSpecialA = OleUIPasteSpecialA(
    param0 : OLEUIPASTESPECIALA*   # OLEUIPASTESPECIALA*
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef OleUIPasteSpecialANative = Uint32 Function(Pointer<Void>);
typedef OleUIPasteSpecialADart = int Function(Pointer<Void>);
final OleUIPasteSpecialA = DynamicLibrary.open('oledlg.dll')
    .lookupFunction<OleUIPasteSpecialANative, OleUIPasteSpecialADart>('OleUIPasteSpecialA');
// param0 : OLEUIPASTESPECIALA* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function OleUIPasteSpecialA(
  param0: Pointer   // OLEUIPASTESPECIALA*
): DWORD; stdcall;
  external 'oledlg.dll' name 'OleUIPasteSpecialA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "OleUIPasteSpecialA"
  c_OleUIPasteSpecialA :: Ptr () -> IO Word32
-- param0 : OLEUIPASTESPECIALA* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let oleuipastespeciala =
  foreign "OleUIPasteSpecialA"
    ((ptr void) @-> returning uint32_t)
(* param0 : OLEUIPASTESPECIALA* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library oledlg (t "oledlg.dll"))
(cffi:use-foreign-library oledlg)

(cffi:defcfun ("OleUIPasteSpecialA" ole-uipaste-special-a :convention :stdcall) :uint32
  (param0 :pointer))   ; OLEUIPASTESPECIALA*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OleUIPasteSpecialA = Win32::API::More->new('oledlg',
    'DWORD OleUIPasteSpecialA(LPVOID param0)');
# my $ret = $OleUIPasteSpecialA->Call($param0);
# param0 : OLEUIPASTESPECIALA* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目
使用する型