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

OleUIObjectPropertiesA

関数
OLEオブジェクトのプロパティシートを表示する。ANSI版。
DLLoledlg.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD OleUIObjectPropertiesA(
    OLEUIOBJECTPROPSA* param0
);

パラメーター

名前方向説明
param0OLEUIOBJECTPROPSA*inオブジェクトのプロパティシートを構成するOLEUIOBJECTPROPSA構造体へのポインタ。

戻り値の型: DWORD

公式ドキュメント

オブジェクトのプロパティダイアログボックスを呼び出します。このダイアログは、オブジェクトに関する全般 (General)、表示 (View)、リンク (Link) の情報を表示します。(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_OPERR_SUBPROPNULL
lpGP または lpVPNULL であるか、dwFlags および OPF_OBJECTISLINKlpLPNULL です。
OLEUI_OPERR_SUBPROPINVALID
lpGPlpVP、または lpLP が指す構造体に対する書き込みアクセス権が不足しています。
OLEUI_OPERR_PROPSHEETNULL
lpLP の値が NULL です。
OLEUI_OPERR_PROPSHEETINVALID
lpGPlpVP、または lpLP が指す構造体に対する書き込みアクセス権が不足しています。
OLEUI_OPERR_SUPPROP
サブリンクプロパティへのポインター lpLPNULL です。
OLEUI_OPERR_PROPSINVALID
サブリンクプロパティへのポインター lpLP に対する書き込みアクセス権が不足しています。
OLEUI_OPERR_PAGESINCORRECT
lpPS メンバーの一部のサブリンクプロパティが正しくありません。
OLEUI_OPERR_INVALIDPAGES
lpPS メンバーの一部のサブリンクプロパティが正しくありません。
OLEUI_OPERR_NOTSUPPORTED
lpPS メンバーのサブリンクプロパティが正しくありません。
OLEUI_OPERR_DLGPROCNOTNULL
lpPS メンバーのサブリンクプロパティが正しくありません。
OLEUI_OPERR_LPARAMNOTZERO
lpPS メンバーのサブリンクプロパティが正しくありません。
OLEUI_GPERR_STRINGINVALID
文字列値 (例: lplpszLabel または lplpszType) が無効です。
OLEUI_GPERR_CLASSIDINVALID
clsid の値が無効です。
OLEUI_GPERR_LPCLSIDEXCLUDEINVALID
ClsidExcluded の値が無効です。
OLEUI_GPERR_CBFORMATINVALID
wFormat の値が無効です。
OLEUI_VPERR_METAPICTINVALID
hMetaPict の値が無効です。
OLEUI_VPERR_DVASPECTINVALID
dvAspect の値が無効です。
OLEUI_OPERR_PROPERTYSHEET
lpPS の値が正しくありません。
OLEUI_OPERR_OBJINFOINVALID
lpObjInfo の値が NULL であるか、呼び出し元プロセスに読み取りアクセス権がありません。
OLEUI_OPERR_LINKINFOINVALID

lpLinkInfo の値が NULL であるか、呼び出し元プロセスに読み取りアクセス権がありません。

解説(Remarks)

OleUIObjectProperties には OLEUIOBJECTPROPS 構造体が渡されます。この構造体は、オブジェクトのプロパティ ダイアログボックスの 全般 (General)表示 (View)リンク (Link) の各タブを埋めるために必要な情報を提供します。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 OleUIObjectPropertiesA(
    OLEUIOBJECTPROPSA* param0
);
[DllImport("oledlg.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint OleUIObjectPropertiesA(
    IntPtr param0   // OLEUIOBJECTPROPSA*
);
<DllImport("oledlg.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function OleUIObjectPropertiesA(
    param0 As IntPtr   ' OLEUIOBJECTPROPSA*
) As UInteger
End Function
' param0 : OLEUIOBJECTPROPSA*
Declare PtrSafe Function OleUIObjectPropertiesA 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

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

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

var (
	oledlg = windows.NewLazySystemDLL("oledlg.dll")
	procOleUIObjectPropertiesA = oledlg.NewProc("OleUIObjectPropertiesA")
)

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

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

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

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

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

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

関連項目

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