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

GetStockObject

関数
システム標準のストックGDIオブジェクトを取得する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HGDIOBJ GetStockObject(
    GET_STOCK_OBJECT_FLAGS i
);

パラメーター

名前方向説明
iGET_STOCK_OBJECT_FLAGSin

ストックオブジェクトの種類です。このパラメーターには次のいずれかの値を指定できます。

意味
BLACK_BRUSH
黒のブラシ。
DKGRAY_BRUSH
濃い灰色のブラシ。
DC_BRUSH
単色のブラシ。既定の色は白です。色は SetDCBrushColor 関数を使用して変更できます。詳細については、「解説」セクションを参照してください。
GRAY_BRUSH
灰色のブラシ。
HOLLOW_BRUSH
中空のブラシ(NULL_BRUSH と同等)。
LTGRAY_BRUSH
明るい灰色のブラシ。
NULL_BRUSH
Null ブラシ(HOLLOW_BRUSH と同等)。
WHITE_BRUSH
白のブラシ。
BLACK_PEN
黒のペン。
DC_PEN
単色のペン。既定の色は黒です。色は SetDCPenColor 関数を使用して変更できます。詳細については、「解説」セクションを参照してください。
NULL_PEN
Null ペン。Null ペンは何も描画しません。
WHITE_PEN
白のペン。
ANSI_FIXED_FONT
Windows の固定ピッチ(等幅)システムフォント。
ANSI_VAR_FONT
Windows の可変ピッチ(プロポーショナル)システムフォント。
DEVICE_DEFAULT_FONT
デバイス依存のフォント。
DEFAULT_GUI_FONT
メニューやダイアログボックスなどのユーザーインターフェイスオブジェクト用の既定のフォント。ダイアログやウィンドウで使用されるフォントを取得するために DEFAULT_GUI_FONTSYSTEM_FONT を使用することは推奨されません。詳細については、「解説」セクションを参照してください。

既定のフォントは Tahoma です。

OEM_FIXED_FONT
OEM(相手先ブランド製造会社)依存の固定ピッチ(等幅)フォント。
SYSTEM_FONT
システムフォント。既定では、システムはメニュー、ダイアログボックスのコントロール、およびテキストの描画にシステムフォントを使用します。ダイアログやウィンドウで使用されるフォントを取得するために DEFAULT_GUI_FONTSYSTEM_FONT を使用することは推奨されません。詳細については、「解説」セクションを参照してください。

既定のシステムフォントは Tahoma です。

SYSTEM_FIXED_FONT
固定ピッチ(等幅)システムフォント。このストックオブジェクトは、3.0 より前の 16 ビット版 Windows との互換性のためにのみ提供されています。
DEFAULT_PALETTE
既定のパレット。このパレットは、システムパレット内の静的な色で構成されます。

戻り値の型: HGDIOBJ

公式ドキュメント

GetStockObject 関数は、ストックのペン、ブラシ、フォント、またはパレットのいずれかへのハンドルを取得します。

戻り値

関数が成功した場合、戻り値は要求された論理オブジェクトへのハンドルです。

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

解説(Remarks)

この方法を使用してダイアログやウィンドウで使用されている現在のフォントを取得することは推奨されません。代わりに、SystemParametersInfo 関数に SPI_GETNONCLIENTMETRICS パラメーターを指定して現在のフォントを取得してください。SystemParametersInfo は現在のテーマを考慮し、キャプション、メニュー、メッセージダイアログのフォント情報を提供します。

DKGRAY_BRUSHGRAY_BRUSH、および LTGRAY_BRUSH のストックオブジェクトは、CS_HREDRAW および CS_VREDRAW スタイルを持つウィンドウでのみ使用してください。これら以外のスタイルのウィンドウで灰色のストックブラシを使用すると、ウィンドウの移動やサイズ変更の後にブラシパターンの位置がずれる可能性があります。ストックブラシの原点は調整できません。

HOLLOW_BRUSHNULL_BRUSH のストックオブジェクトは同等です。

ストックオブジェクトを DeleteObject を呼び出して削除する必要はありません(削除しても害はありません)。

DC_BRUSHDC_PEN はどちらも、BLACK_BRUSHBLACK_PEN などの他のストックオブジェクトと同じように使用できます。現在のペンまたはブラシの色を取得する方法については、GetDCBrushColor および GetDCPenColor を参照してください。色を設定する例については、Setting the Pen or Brush Color を参照してください。DC_BRUSH または DC_PEN を引数とする GetStockObject 関数は、SetDCPenColor および SetDCBrushColor 関数と同じように使用できます。

例については、Setting the Pen or Brush Color を参照してください。

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

各言語での呼び出し定義

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

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

GetStockObject = ctypes.windll.gdi32.GetStockObject
GetStockObject.restype = ctypes.c_void_p
GetStockObject.argtypes = [
    ctypes.c_int,  # i : GET_STOCK_OBJECT_FLAGS
]
require 'fiddle'
require 'fiddle/import'

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

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procGetStockObject = gdi32.NewProc("GetStockObject")
)

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

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

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

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

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

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

関連項目

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