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

GetObjectW

関数
GDIオブジェクトの情報を構造体に取得する(Unicode版)。
DLLGDI32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// GDI32.dll  (Unicode / -W)
#include <windows.h>

INT GetObjectW(
    HGDIOBJ h,
    INT c,
    void* pv   // optional
);

パラメーター

名前方向説明
hHGDIOBJin情報を取得する対象GDIオブジェクトのハンドル。ペン/ブラシ/フォント/ビットマップ等。
cINTinpvバッファのバイト数。取得する構造体のサイズを指定する。
pvvoid*outoptionalオブジェクト情報を受け取るバッファへのポインタ。NULL指定で必要サイズを返す。

戻り値の型: INT

公式ドキュメント

GetObjectW (Unicode) 関数 (wingdi.h) は、指定されたグラフィックスオブジェクトに関する情報を取得します。

戻り値

関数が成功し、かつ lpvObject が有効なポインターである場合、戻り値はバッファに格納されたバイト数です。

関数が成功し、かつ lpvObjectNULL である場合、戻り値は、関数がバッファに格納する情報を保持するために必要なバイト数です。

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

解説(Remarks)

lpvObject パラメーターが指すバッファは、グラフィックスオブジェクトに関する情報を受け取るのに十分な大きさでなければなりません。グラフィックスオブジェクトに応じて、関数は BITMAPDIBSECTIONEXTLOGPENLOGBRUSHLOGFONT、もしくは LOGPEN 構造体、または (論理パレットの場合は) テーブルエントリのカウント値を使用します。

hgdiobjCreateDIBSection を呼び出して作成されたビットマップへのハンドルであり、指定されたバッファが十分に大きい場合、GetObject 関数は DIBSECTION 構造体を返します。さらに、DIBSECTION に含まれる BITMAP 構造体の bmBits メンバーには、ビットマップのビット値へのポインターが格納されます。

hgdiobj がその他の方法で作成されたビットマップへのハンドルである場合、GetObject はビットマップの幅、高さ、および色フォーマットの情報のみを返します。ビットマップのビット値は、GetDIBits 関数または GetBitmapBits 関数を呼び出して取得できます。

hgdiobj が論理パレットへのハンドルである場合、GetObject はパレット内のエントリ数を指定する 2 バイトの整数を取得します。この関数は、パレットを定義する LOGPALETTE 構造体を取得しません。パレットエントリに関する情報を取得するには、アプリケーションは GetPaletteEntries 関数を呼び出すことができます。

hgdiobj がフォントへのハンドルである場合、返される LOGFONT は、そのフォントの作成に使用された LOGFONT です。正確な LOGFONT を表現できなかったために Windows がフォントを補間 (interpolation) する必要があった場合、その補間は LOGFONT には反映されません。たとえば、縦書き描画をサポートしないフォントの縦書き版を要求した場合、LOGFONT はフォントが縦書きであることを示しますが、Windows はそれを横書きで描画します。

例については、Storing an Image を参照してください。

メモ

wingdi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして GetObject を定義しています。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// GDI32.dll  (Unicode / -W)
#include <windows.h>

INT GetObjectW(
    HGDIOBJ h,
    INT c,
    void* pv   // optional
);
[DllImport("GDI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int GetObjectW(
    IntPtr h,   // HGDIOBJ
    int c,   // INT
    IntPtr pv   // void* optional, out
);
<DllImport("GDI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function GetObjectW(
    h As IntPtr,   ' HGDIOBJ
    c As Integer,   ' INT
    pv As IntPtr   ' void* optional, out
) As Integer
End Function
' h : HGDIOBJ
' c : INT
' pv : void* optional, out
Declare PtrSafe Function GetObjectW Lib "gdi32" ( _
    ByVal h As LongPtr, _
    ByVal c As Long, _
    ByVal pv As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetObjectW = ctypes.windll.gdi32.GetObjectW
GetObjectW.restype = ctypes.c_int
GetObjectW.argtypes = [
    wintypes.HANDLE,  # h : HGDIOBJ
    ctypes.c_int,  # c : INT
    ctypes.POINTER(None),  # pv : void* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
GetObjectW = Fiddle::Function.new(
  lib['GetObjectW'],
  [
    Fiddle::TYPE_VOIDP,  # h : HGDIOBJ
    Fiddle::TYPE_INT,  # c : INT
    Fiddle::TYPE_VOIDP,  # pv : void* optional, out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "gdi32")]
extern "system" {
    fn GetObjectW(
        h: *mut core::ffi::c_void,  // HGDIOBJ
        c: i32,  // INT
        pv: *mut ()  // void* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("GDI32.dll", CharSet = CharSet.Unicode)]
public static extern int GetObjectW(IntPtr h, int c, IntPtr pv);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GetObjectW' -Namespace Win32 -PassThru
# $api::GetObjectW(h, c, pv)
#uselib "GDI32.dll"
#func global GetObjectW "GetObjectW" wptr, wptr, wptr
; GetObjectW h, c, pv   ; 戻り値は stat
; h : HGDIOBJ -> "wptr"
; c : INT -> "wptr"
; pv : void* optional, out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "GDI32.dll"
#cfunc global GetObjectW "GetObjectW" sptr, int, sptr
; res = GetObjectW(h, c, pv)
; h : HGDIOBJ -> "sptr"
; c : INT -> "int"
; pv : void* optional, out -> "sptr"
; INT GetObjectW(HGDIOBJ h, INT c, void* pv)
#uselib "GDI32.dll"
#cfunc global GetObjectW "GetObjectW" intptr, int, intptr
; res = GetObjectW(h, c, pv)
; h : HGDIOBJ -> "intptr"
; c : INT -> "int"
; pv : void* optional, out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procGetObjectW = gdi32.NewProc("GetObjectW")
)

// h (HGDIOBJ), c (INT), pv (void* optional, out)
r1, _, err := procGetObjectW.Call(
	uintptr(h),
	uintptr(c),
	uintptr(pv),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function GetObjectW(
  h: THandle;   // HGDIOBJ
  c: Integer;   // INT
  pv: Pointer   // void* optional, out
): Integer; stdcall;
  external 'GDI32.dll' name 'GetObjectW';
result := DllCall("GDI32\GetObjectW"
    , "Ptr", h   ; HGDIOBJ
    , "Int", c   ; INT
    , "Ptr", pv   ; void* optional, out
    , "Int")   ; return: INT
●GetObjectW(h, c, pv) = DLL("GDI32.dll", "int GetObjectW(void*, int, void*)")
# 呼び出し: GetObjectW(h, c, pv)
# h : HGDIOBJ -> "void*"
# c : INT -> "int"
# pv : void* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "gdi32" fn GetObjectW(
    h: ?*anyopaque, // HGDIOBJ
    c: i32, // INT
    pv: ?*anyopaque // void* optional, out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc GetObjectW(
    h: pointer,  # HGDIOBJ
    c: int32,  # INT
    pv: pointer  # void* optional, out
): int32 {.importc: "GetObjectW", stdcall, dynlib: "GDI32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "gdi32");
extern(Windows)
int GetObjectW(
    void* h,   // HGDIOBJ
    int c,   // INT
    void* pv   // void* optional, out
);
ccall((:GetObjectW, "GDI32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Int32, Ptr{Cvoid}),
      h, c, pv)
# h : HGDIOBJ -> Ptr{Cvoid}
# c : INT -> Int32
# pv : void* optional, out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetObjectW(
    void* h,
    int32_t c,
    void* pv);
]]
local gdi32 = ffi.load("gdi32")
-- gdi32.GetObjectW(h, c, pv)
-- h : HGDIOBJ
-- c : INT
-- pv : void* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('GDI32.dll');
const GetObjectW = lib.func('__stdcall', 'GetObjectW', 'int32_t', ['void *', 'int32_t', 'void *']);
// GetObjectW(h, c, pv)
// h : HGDIOBJ -> 'void *'
// c : INT -> 'int32_t'
// pv : void* optional, out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("GDI32.dll", {
  GetObjectW: { parameters: ["pointer", "i32", "pointer"], result: "i32" },
});
// lib.symbols.GetObjectW(h, c, pv)
// h : HGDIOBJ -> "pointer"
// c : INT -> "i32"
// pv : void* optional, out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetObjectW(
    void* h,
    int32_t c,
    void* pv);
C, "GDI32.dll");
// $ffi->GetObjectW(h, c, pv);
// h : HGDIOBJ
// c : INT
// pv : void* optional, out
// 構造体/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, W32APIOptions.UNICODE_OPTIONS);
    int GetObjectW(
        Pointer h,   // HGDIOBJ
        int c,   // INT
        Pointer pv   // void* optional, out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("gdi32")]
lib LibGDI32
  fun GetObjectW = GetObjectW(
    h : Void*,   # HGDIOBJ
    c : Int32,   # INT
    pv : Void*   # void* optional, out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetObjectWNative = Int32 Function(Pointer<Void>, Int32, Pointer<Void>);
typedef GetObjectWDart = int Function(Pointer<Void>, int, Pointer<Void>);
final GetObjectW = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<GetObjectWNative, GetObjectWDart>('GetObjectW');
// h : HGDIOBJ -> Pointer<Void>
// c : INT -> Int32
// pv : void* optional, out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetObjectW(
  h: THandle;   // HGDIOBJ
  c: Integer;   // INT
  pv: Pointer   // void* optional, out
): Integer; stdcall;
  external 'GDI32.dll' name 'GetObjectW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetObjectW"
  c_GetObjectW :: Ptr () -> Int32 -> Ptr () -> IO Int32
-- h : HGDIOBJ -> Ptr ()
-- c : INT -> Int32
-- pv : void* optional, out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("GetObjectW" get-object-w :convention :stdcall) :int32
  (h :pointer)   ; HGDIOBJ
  (c :int32)   ; INT
  (pv :pointer))   ; void* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetObjectW = Win32::API::More->new('GDI32',
    'int GetObjectW(HANDLE h, int c, LPVOID pv)');
# my $ret = $GetObjectW->Call($h, $c, $pv);
# h : HGDIOBJ -> HANDLE
# c : INT -> int
# pv : void* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目