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

GetBitmapBits

関数
ビットマップのビット列をバッファへコピーする。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

INT GetBitmapBits(
    HBITMAP hbit,
    INT cb,
    void* lpvBits
);

パラメーター

名前方向説明
hbitHBITMAPinデバイス依存ビットマップへのハンドルです。
cbINTinビットマップからバッファーへコピーするバイト数です。
lpvBitsvoid*outビットマップビットを受け取るバッファーへのポインターです。ビットはバイト値の配列として格納されます。

戻り値の型: INT

公式ドキュメント

GetBitmapBits 関数は、指定したデバイス依存ビットマップのビットマップビットをバッファーにコピーします。

戻り値

関数が成功した場合、戻り値はバッファーにコピーされたバイト数です。

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

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

各言語での呼び出し定義

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

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

GetBitmapBits = ctypes.windll.gdi32.GetBitmapBits
GetBitmapBits.restype = ctypes.c_int
GetBitmapBits.argtypes = [
    wintypes.HANDLE,  # hbit : HBITMAP
    ctypes.c_int,  # cb : INT
    ctypes.POINTER(None),  # lpvBits : void* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procGetBitmapBits = gdi32.NewProc("GetBitmapBits")
)

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

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

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

foreign import stdcall safe "GetBitmapBits"
  c_GetBitmapBits :: Ptr () -> Int32 -> Ptr () -> IO Int32
-- hbit : HBITMAP -> Ptr ()
-- cb : INT -> Int32
-- lpvBits : void* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getbitmapbits =
  foreign "GetBitmapBits"
    ((ptr void) @-> int32_t @-> (ptr void) @-> returning int32_t)
(* hbit : HBITMAP -> (ptr void) *)
(* cb : INT -> int32_t *)
(* lpvBits : void* 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 ("GetBitmapBits" get-bitmap-bits :convention :stdcall) :int32
  (hbit :pointer)   ; HBITMAP
  (cb :int32)   ; INT
  (lpv-bits :pointer))   ; void* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetBitmapBits = Win32::API::More->new('GDI32',
    'int GetBitmapBits(HANDLE hbit, int cb, LPVOID lpvBits)');
# my $ret = $GetBitmapBits->Call($hbit, $cb, $lpvBits);
# hbit : HBITMAP -> HANDLE
# cb : INT -> int
# lpvBits : void* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。