ホーム › System.Ole › OleTranslateAccelerator

OleTranslateAccelerator

関数

インプレース編集中のアクセラレータキーを処理する。

DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// OLE32.dll
#include <windows.h>

HRESULT OleTranslateAccelerator(
    IOleInPlaceFrame* lpFrame,
    OLEINPLACEFRAMEINFO* lpFrameInfo,
    MSG* lpmsg
);

パラメーター

名前	型	方向	説明
lpFrame	IOleInPlaceFrame*	in	キーストロークの送信先となる IOleInPlaceFrame インターフェイスへのポインターです。
lpFrameInfo	OLEINPLACEFRAMEINFO*	in	コンテナから取得したアクセラレータテーブルを含む OLEINPLACEFRAMEINFO 構造体へのポインターです。
lpmsg	MSG*	in	キーストロークを含む MSG 構造体へのポインターです。

戻り値の型: HRESULT

公式ドキュメント

オブジェクトアプリケーションから呼び出され、オブジェクトのコンテナがコンテナのアクセラレータテーブルに従ってアクセラレータを変換できるようにします。

戻り値

この関数は成功すると S_OK を返します。その他に返される可能性のある値は次のとおりです。

戻り値	説明
E_FAIL	オブジェクトはこのメッセージの処理を続行する必要があります。

解説(Remarks)

オブジェクトサーバーは、lpFrameInfo が指すコンテナのアクセラレータテーブルに従ってオブジェクトのコンテナがアクセラレータキーストロークを変換できるようにするために、OleTranslateAccelerator を呼び出します。格納されたオブジェクトがアクティブオブジェクトである間、そのオブジェクトのサーバーは常に受信したメッセージを最初に変換する機会を持ちます。これが望ましくない場合、サーバーは OleTranslateAccelerator を呼び出してオブジェクトのコンテナに機会を与えます。キーボード入力がコンテナから提供されたアクセラレータテーブル内のアクセラレータと一致する場合、OleTranslateAccelerator は IOleInPlaceFrame::TranslateAccelerator メソッドを通じてメッセージとそのコマンド識別子をコンテナに渡します。このメソッドは、キーストロークが消費された場合は S_OK を返し、それ以外の場合は S_FALSE を返します。

コンテナのアクセラレータテーブルは、独自のアクセラレータキーストローク変換を行うオブジェクトアプリケーションでも正しく機能するように定義する必要があります。これらのテーブルは次の形式を取る必要があります。

"char", wID, VIRTKEY, CONTROL

これはキーボードアクセラレータを記述する最も一般的な方法です。これに従わないと、インプレースセッション中にキーストロークが失われたり、誤ったオブジェクトに送信されたりする可能性があります。

オブジェクトは、IsAccelerator 関数を呼び出して、アクセラレータキーストロークがオブジェクトとコンテナのどちらに属するかを確認できます。

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

各言語での呼び出し定義

// OLE32.dll
#include <windows.h>

HRESULT OleTranslateAccelerator(
    IOleInPlaceFrame* lpFrame,
    OLEINPLACEFRAMEINFO* lpFrameInfo,
    MSG* lpmsg
);

[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int OleTranslateAccelerator(
    IntPtr lpFrame,   // IOleInPlaceFrame*
    IntPtr lpFrameInfo,   // OLEINPLACEFRAMEINFO*
    IntPtr lpmsg   // MSG*
);

<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function OleTranslateAccelerator(
    lpFrame As IntPtr,   ' IOleInPlaceFrame*
    lpFrameInfo As IntPtr,   ' OLEINPLACEFRAMEINFO*
    lpmsg As IntPtr   ' MSG*
) As Integer
End Function

' lpFrame : IOleInPlaceFrame*
' lpFrameInfo : OLEINPLACEFRAMEINFO*
' lpmsg : MSG*
Declare PtrSafe Function OleTranslateAccelerator Lib "ole32" ( _
    ByVal lpFrame As LongPtr, _
    ByVal lpFrameInfo As LongPtr, _
    ByVal lpmsg As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

OleTranslateAccelerator = ctypes.windll.ole32.OleTranslateAccelerator
OleTranslateAccelerator.restype = ctypes.c_int
OleTranslateAccelerator.argtypes = [
    ctypes.c_void_p,  # lpFrame : IOleInPlaceFrame*
    ctypes.c_void_p,  # lpFrameInfo : OLEINPLACEFRAMEINFO*
    ctypes.c_void_p,  # lpmsg : MSG*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
OleTranslateAccelerator = Fiddle::Function.new(
  lib['OleTranslateAccelerator'],
  [
    Fiddle::TYPE_VOIDP,  # lpFrame : IOleInPlaceFrame*
    Fiddle::TYPE_VOIDP,  # lpFrameInfo : OLEINPLACEFRAMEINFO*
    Fiddle::TYPE_VOIDP,  # lpmsg : MSG*
  ],
  Fiddle::TYPE_INT)

#[link(name = "ole32")]
extern "system" {
    fn OleTranslateAccelerator(
        lpFrame: *mut core::ffi::c_void,  // IOleInPlaceFrame*
        lpFrameInfo: *mut OLEINPLACEFRAMEINFO,  // OLEINPLACEFRAMEINFO*
        lpmsg: *mut MSG  // MSG*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLE32.dll")]
public static extern int OleTranslateAccelerator(IntPtr lpFrame, IntPtr lpFrameInfo, IntPtr lpmsg);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_OleTranslateAccelerator' -Namespace Win32 -PassThru
# $api::OleTranslateAccelerator(lpFrame, lpFrameInfo, lpmsg)

#uselib "OLE32.dll"
#func global OleTranslateAccelerator "OleTranslateAccelerator" sptr, sptr, sptr
; OleTranslateAccelerator lpFrame, varptr(lpFrameInfo), varptr(lpmsg)   ; 戻り値は stat
; lpFrame : IOleInPlaceFrame* -> "sptr"
; lpFrameInfo : OLEINPLACEFRAMEINFO* -> "sptr"
; lpmsg : MSG* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "OLE32.dll"
#cfunc global OleTranslateAccelerator "OleTranslateAccelerator" sptr, var, var
; res = OleTranslateAccelerator(lpFrame, lpFrameInfo, lpmsg)
; lpFrame : IOleInPlaceFrame* -> "sptr"
; lpFrameInfo : OLEINPLACEFRAMEINFO* -> "var"
; lpmsg : MSG* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLE32.dll"
#cfunc global OleTranslateAccelerator "OleTranslateAccelerator" sptr, sptr, sptr
; res = OleTranslateAccelerator(lpFrame, varptr(lpFrameInfo), varptr(lpmsg))
; lpFrame : IOleInPlaceFrame* -> "sptr"
; lpFrameInfo : OLEINPLACEFRAMEINFO* -> "sptr"
; lpmsg : MSG* -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。