Win32 API 日本語リファレンス
ホームDevices.Display › EngLockSurface

EngLockSurface

関数
サーフェスをロックしてサーフェスオブジェクトを取得する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

SURFOBJ* EngLockSurface(
    HSURF hsurf
);

パラメーター

名前方向説明
hsurfHSURFinロックするサーフェスへのハンドル。

戻り値の型: SURFOBJ*

公式ドキュメント

EngLockSurface 関数は、指定されたサーフェスのユーザーオブジェクトを作成します。この関数により、ドライバーは自身が作成したサーフェスにアクセスできます。

戻り値

関数が成功した場合、EngLockSurfaceSURFOBJ 構造体へのポインターを返します。それ以外の場合、この関数は NULL を返します。

解説(Remarks)

この関数により、ドライバーは自身が作成したサーフェスにアクセスできます。

サーフェスが不要になった際にロックを解除する責任はドライバーにあります。サーフェスをロックする期間は、ごく短時間に限定してください。

サーフェスのロックを解除するには、EngUnlockSurface 関数を使用します。

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

各言語での呼び出し定義

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

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

EngLockSurface = ctypes.windll.gdi32.EngLockSurface
EngLockSurface.restype = ctypes.c_void_p
EngLockSurface.argtypes = [
    wintypes.HANDLE,  # hsurf : HSURF
]
require 'fiddle'
require 'fiddle/import'

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

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procEngLockSurface = gdi32.NewProc("EngLockSurface")
)

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

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

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

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

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

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

関連項目

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