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

OleUIChangeIconA

関数
オブジェクトのアイコンを変更するダイアログを表示する。ANSI版。
DLLoledlg.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD OleUIChangeIconA(
    OLEUICHANGEICONA* param0
);

パラメーター

名前方向説明
param0OLEUICHANGEICONA*inアイコンの変更ダイアログを構成するOLEUICHANGEICONA構造体へのポインタ。入出力兼用。

戻り値の型: DWORD

公式ドキュメント

標準の [アイコンの変更] ダイアログ ボックスを呼び出します。これにより、ユーザーはアイコン ファイル、実行可能ファイル、または DLL からアイコンを選択できます。(ANSI)

戻り値

標準の成功/エラー定義

戻り値 説明
OLEUI_FALSE
原因不明の失敗 (未使用)。
OLEUI_OK
ユーザーが OK ボタンを押しました。
OLEUI_SUCCESS
エラーなし。OLEUI_OK と同じです。
OLEUI_CANCEL
ユーザーが 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_CIERR_MUSTHAVECLSID
clsid メンバーが現在の CLSID ではありませんでした。
OLEUI_CIERR_MUSTHAVECURRENTMETAFILE
hMetaPict メンバーが現在のメタファイルではありませんでした。
OLEUI_CIERR_SZICONEXEINVALID
szIconExe の値が無効でした。

解説(Remarks)

OLEUICHANGEICON 構造体。

メモ

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

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

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

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

var (
	oledlg = windows.NewLazySystemDLL("oledlg.dll")
	procOleUIChangeIconA = oledlg.NewProc("OleUIChangeIconA")
)

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

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

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

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

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

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

関連項目

文字セット違い
使用する型