ホーム › Graphics.Gdi › SetBitmapDimensionEx

SetBitmapDimensionEx

関数

ビットマップの物理寸法(0.1mm単位)を設定する。

DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL SetBitmapDimensionEx(
    HBITMAP hbm,
    INT w,
    INT h,
    SIZE* lpsz   // optional
);

パラメーター

名前	型	方向	説明
hbm	HBITMAP	in	ビットマップへのハンドル。このビットマップを DIB セクションビットマップにすることはできません。
w	INT	in	ビットマップの幅(0.1 ミリメートル単位)。
h	INT	in	ビットマップの高さ(0.1 ミリメートル単位)。
lpsz	SIZE*	outoptional	ビットマップの以前の寸法を受け取る SIZE 構造体へのポインター。このポインターは NULL でもかまいません。

戻り値の型: BOOL

公式ドキュメント

SetBitmapDimensionEx 関数は、ビットマップに推奨される寸法を割り当てます。これらの寸法はアプリケーションで使用できますが、システムでは使用されません。

戻り値

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

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

解説(Remarks)

アプリケーションは、SetBitmapDimensionEx 関数でビットマップに割り当てられた寸法を、GetBitmapDimensionEx 関数を呼び出すことで取得できます。

hBitmap で識別されるビットマップを、DIB セクション(CreateDIBSection 関数で作成されたビットマップ)にすることはできません。ビットマップが DIB セクションである場合、SetBitmapDimensionEx 関数は失敗します。

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

各言語での呼び出し定義

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

BOOL SetBitmapDimensionEx(
    HBITMAP hbm,
    INT w,
    INT h,
    SIZE* lpsz   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool SetBitmapDimensionEx(
    IntPtr hbm,   // HBITMAP
    int w,   // INT
    int h,   // INT
    IntPtr lpsz   // SIZE* optional, out
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function SetBitmapDimensionEx(
    hbm As IntPtr,   ' HBITMAP
    w As Integer,   ' INT
    h As Integer,   ' INT
    lpsz As IntPtr   ' SIZE* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hbm : HBITMAP
' w : INT
' h : INT
' lpsz : SIZE* optional, out
Declare PtrSafe Function SetBitmapDimensionEx Lib "gdi32" ( _
    ByVal hbm As LongPtr, _
    ByVal w As Long, _
    ByVal h As Long, _
    ByVal lpsz As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetBitmapDimensionEx = ctypes.windll.gdi32.SetBitmapDimensionEx
SetBitmapDimensionEx.restype = wintypes.BOOL
SetBitmapDimensionEx.argtypes = [
    wintypes.HANDLE,  # hbm : HBITMAP
    ctypes.c_int,  # w : INT
    ctypes.c_int,  # h : INT
    ctypes.c_void_p,  # lpsz : SIZE* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
SetBitmapDimensionEx = Fiddle::Function.new(
  lib['SetBitmapDimensionEx'],
  [
    Fiddle::TYPE_VOIDP,  # hbm : HBITMAP
    Fiddle::TYPE_INT,  # w : INT
    Fiddle::TYPE_INT,  # h : INT
    Fiddle::TYPE_VOIDP,  # lpsz : SIZE* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn SetBitmapDimensionEx(
        hbm: *mut core::ffi::c_void,  // HBITMAP
        w: i32,  // INT
        h: i32,  // INT
        lpsz: *mut SIZE  // SIZE* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll")]
public static extern bool SetBitmapDimensionEx(IntPtr hbm, int w, int h, IntPtr lpsz);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_SetBitmapDimensionEx' -Namespace Win32 -PassThru
# $api::SetBitmapDimensionEx(hbm, w, h, lpsz)

#uselib "GDI32.dll"
#func global SetBitmapDimensionEx "SetBitmapDimensionEx" sptr, sptr, sptr, sptr
; SetBitmapDimensionEx hbm, w, h, varptr(lpsz)   ; 戻り値は stat
; hbm : HBITMAP -> "sptr"
; w : INT -> "sptr"
; h : INT -> "sptr"
; lpsz : SIZE* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "GDI32.dll"
#cfunc global SetBitmapDimensionEx "SetBitmapDimensionEx" sptr, int, int, var
; res = SetBitmapDimensionEx(hbm, w, h, lpsz)
; hbm : HBITMAP -> "sptr"
; w : INT -> "int"
; h : INT -> "int"
; lpsz : SIZE* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "GDI32.dll"
#cfunc global SetBitmapDimensionEx "SetBitmapDimensionEx" sptr, int, int, sptr
; res = SetBitmapDimensionEx(hbm, w, h, varptr(lpsz))
; hbm : HBITMAP -> "sptr"
; w : INT -> "int"
; h : INT -> "int"
; lpsz : SIZE* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。