Win32 API 日本語リファレンス
ホームGraphics.Gdi › UnrealizeObject

UnrealizeObject

関数
論理パレットのリセットまたはブラシ原点のリセットを行う。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL UnrealizeObject(
    HGDIOBJ h
);

パラメーター

名前方向説明
hHGDIOBJin対象GDIオブジェクトのハンドル。論理パレットまたはブラシを指定する。

戻り値の型: BOOL

公式ドキュメント

UnrealizeObject 関数は、ブラシの原点をリセットするか、または論理パレットをリセットします。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。

解説(Remarks)

UnrealizeObject 関数は、ストックオブジェクトに対して使用しないでください。たとえば、GetStockObject (DEFAULT_PALETTE) を呼び出して取得される既定のパレットは、ストックオブジェクトです。

hgdiobj で識別されるパレットは、デバイスコンテキストの現在選択されているパレットである場合があります。

hgdiobj がブラシの場合、UnrealizeObject は何も行わず、関数は TRUE を返します。ブラシの原点を設定するには、SetBrushOrgEx を使用してください。

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

各言語での呼び出し定義

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

BOOL UnrealizeObject(
    HGDIOBJ h
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool UnrealizeObject(
    IntPtr h   // HGDIOBJ
);
<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function UnrealizeObject(
    h As IntPtr   ' HGDIOBJ
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' h : HGDIOBJ
Declare PtrSafe Function UnrealizeObject Lib "gdi32" ( _
    ByVal h As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

UnrealizeObject = ctypes.windll.gdi32.UnrealizeObject
UnrealizeObject.restype = wintypes.BOOL
UnrealizeObject.argtypes = [
    wintypes.HANDLE,  # h : HGDIOBJ
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
UnrealizeObject = Fiddle::Function.new(
  lib['UnrealizeObject'],
  [
    Fiddle::TYPE_VOIDP,  # h : HGDIOBJ
  ],
  Fiddle::TYPE_INT)
#[link(name = "gdi32")]
extern "system" {
    fn UnrealizeObject(
        h: *mut core::ffi::c_void  // HGDIOBJ
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll")]
public static extern bool UnrealizeObject(IntPtr h);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_UnrealizeObject' -Namespace Win32 -PassThru
# $api::UnrealizeObject(h)
#uselib "GDI32.dll"
#func global UnrealizeObject "UnrealizeObject" sptr
; UnrealizeObject h   ; 戻り値は stat
; h : HGDIOBJ -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "GDI32.dll"
#cfunc global UnrealizeObject "UnrealizeObject" sptr
; res = UnrealizeObject(h)
; h : HGDIOBJ -> "sptr"
; BOOL UnrealizeObject(HGDIOBJ h)
#uselib "GDI32.dll"
#cfunc global UnrealizeObject "UnrealizeObject" intptr
; res = UnrealizeObject(h)
; h : HGDIOBJ -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procUnrealizeObject = gdi32.NewProc("UnrealizeObject")
)

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

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

typedef UnrealizeObjectNative = Int32 Function(Pointer<Void>);
typedef UnrealizeObjectDart = int Function(Pointer<Void>);
final UnrealizeObject = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<UnrealizeObjectNative, UnrealizeObjectDart>('UnrealizeObject');
// h : HGDIOBJ -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function UnrealizeObject(
  h: THandle   // HGDIOBJ
): BOOL; stdcall;
  external 'GDI32.dll' name 'UnrealizeObject';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "UnrealizeObject"
  c_UnrealizeObject :: Ptr () -> IO CInt
-- h : HGDIOBJ -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let unrealizeobject =
  foreign "UnrealizeObject"
    ((ptr void) @-> returning int32_t)
(* h : HGDIOBJ -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library gdi32 (t "GDI32.dll"))
(cffi:use-foreign-library gdi32)

(cffi:defcfun ("UnrealizeObject" unrealize-object :convention :stdcall) :int32
  (h :pointer))   ; HGDIOBJ
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $UnrealizeObject = Win32::API::More->new('GDI32',
    'BOOL UnrealizeObject(HANDLE h)');
# my $ret = $UnrealizeObject->Call($h);
# h : HGDIOBJ -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目