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

OleCreatePropertyFrameIndirect

関数
構造体で指定した設定でプロパティページダイアログを生成する。
DLLOLEAUT32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT OleCreatePropertyFrameIndirect(
    OCPFIPARAMS* lpParams
);

パラメーター

名前方向説明
lpParamsOCPFIPARAMS*inダイアログボックスの作成パラメーターを格納した、呼び出し元が割り当てた構造体へのポインター。

戻り値の型: HRESULT

公式ドキュメント

OleCreatePropertyFrame の呼び出し時のように個別のパラメーターを指定するのではなく、パラメーターを格納した構造体 (OCPFIPARAMS) に基づいて、プロパティフレーム、すなわちプロパティシートダイアログボックスを作成します。

戻り値

この関数は、標準の戻り値 E_INVALIDARGE_OUTOFMEMORYE_UNEXPECTED に加えて、次の値をサポートします。

戻り値 説明
S_OK
ダイアログボックスが正常に呼び出され、動作しました。
E_POINTER
lpParams 内のアドレスが無効です。たとえば NULL である可能性があります。

解説(Remarks)

cbStructSize (構造体のサイズ) と dispIDInitialProperty を除き、OCPFIPARAMS 構造体のすべてのメンバーは、OleCreatePropertyFrame のパラメーターと同じ意味を持ちます。dispIDInitialPropertyDISPID_UNKNOWN の場合、これら 2 つの関数の動作は同一になります。

IPerPropertyBrowsing および IPropertyPage2 と連携して動作する dispIDInitialProperty により、呼び出し元はダイアログボックスが表示される際にどの 1 つのプロパティを強調表示するかを指定できます。この機能は OleCreatePropertyFrame を使用する場合には利用できません。最初に表示するページとプロパティを決定するため、プロパティフレームは次の処理を行います。

  1. (*ppUnk)->QueryInterface(IID_IPerPropertyBrowsing, ...) を呼び出して、最初のオブジェクトへのインターフェイスポインターを取得します。
  2. IPerPropertyBrowsing::MapPropertyToPage(dispIDInitialProperty, ...) を呼び出して、強調表示するプロパティを含むページの CLSID を決定します。このフレームが呼び出されるすべてのオブジェクトは、フレームに表示されるプロパティのセットをサポートしている必要があります。
  3. ダイアログボックスが作成されると、手順 2 で取得した CLSID のプロパティページが IPropertyPage::Activate でアクティブ化されます。
  4. プロパティフレームは、アクティブなページに対して IPropertyPage2 をクエリします。
  5. 成功した場合、フレームは IPropertyPage2::EditProperty(dispIDInitialProperty) を呼び出して、そのダイアログボックス内の正しいフィールドを強調表示します。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HRESULT OleCreatePropertyFrameIndirect(
    OCPFIPARAMS* lpParams
);
[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int OleCreatePropertyFrameIndirect(
    IntPtr lpParams   // OCPFIPARAMS*
);
<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function OleCreatePropertyFrameIndirect(
    lpParams As IntPtr   ' OCPFIPARAMS*
) As Integer
End Function
' lpParams : OCPFIPARAMS*
Declare PtrSafe Function OleCreatePropertyFrameIndirect Lib "oleaut32" ( _
    ByVal lpParams As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

OleCreatePropertyFrameIndirect = ctypes.windll.oleaut32.OleCreatePropertyFrameIndirect
OleCreatePropertyFrameIndirect.restype = ctypes.c_int
OleCreatePropertyFrameIndirect.argtypes = [
    ctypes.c_void_p,  # lpParams : OCPFIPARAMS*
]
require 'fiddle'
require 'fiddle/import'

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

var (
	oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
	procOleCreatePropertyFrameIndirect = oleaut32.NewProc("OleCreatePropertyFrameIndirect")
)

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

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

typedef OleCreatePropertyFrameIndirectNative = Int32 Function(Pointer<Void>);
typedef OleCreatePropertyFrameIndirectDart = int Function(Pointer<Void>);
final OleCreatePropertyFrameIndirect = DynamicLibrary.open('OLEAUT32.dll')
    .lookupFunction<OleCreatePropertyFrameIndirectNative, OleCreatePropertyFrameIndirectDart>('OleCreatePropertyFrameIndirect');
// lpParams : OCPFIPARAMS* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function OleCreatePropertyFrameIndirect(
  lpParams: Pointer   // OCPFIPARAMS*
): Integer; stdcall;
  external 'OLEAUT32.dll' name 'OleCreatePropertyFrameIndirect';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let olecreatepropertyframeindirect =
  foreign "OleCreatePropertyFrameIndirect"
    ((ptr void) @-> returning int32_t)
(* lpParams : OCPFIPARAMS* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library oleaut32 (t "OLEAUT32.dll"))
(cffi:use-foreign-library oleaut32)

(cffi:defcfun ("OleCreatePropertyFrameIndirect" ole-create-property-frame-indirect :convention :stdcall) :int32
  (lp-params :pointer))   ; OCPFIPARAMS*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OleCreatePropertyFrameIndirect = Win32::API::More->new('OLEAUT32',
    'int OleCreatePropertyFrameIndirect(LPVOID lpParams)');
# my $ret = $OleCreatePropertyFrameIndirect->Call($lpParams);
# lpParams : OCPFIPARAMS* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型