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

EngCheckAbort

関数
印刷ジョブの中止要求があるか確認する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL EngCheckAbort(
    SURFOBJ* pso
);

パラメーター

名前方向説明
psoSURFOBJ*inout呼び出し元が指定する、以前に GDI から受け取った SURFOBJ 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

EngCheckAbort 関数は、プリンターグラフィックス DLL が印刷ジョブを終了すべきかどうかを判断できるようにします。

戻り値

印刷ジョブを終了すべき場合、この関数は TRUE を返します。印刷ジョブを終了すべきでない場合、または pso が有効な SURFOBJ 構造体を指していない場合、この関数は FALSE を返します。

解説(Remarks)

プリンターグラフィックス DLL は、実行に 5 秒以上かかるグラフィックス DDI 関数の内部から EngCheckAbort を呼び出す必要があります。印刷ジョブを終了すべき場合、プリンターグラフィックス DLL は現在の操作を停止し、EngCheckAbort を呼び出したグラフィックス DDI 関数の戻り値として FALSE を指定して GDI に制御を返す必要があります。

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

各言語での呼び出し定義

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

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

EngCheckAbort = ctypes.windll.gdi32.EngCheckAbort
EngCheckAbort.restype = wintypes.BOOL
EngCheckAbort.argtypes = [
    ctypes.c_void_p,  # pso : SURFOBJ* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
EngCheckAbort = Fiddle::Function.new(
  lib['EngCheckAbort'],
  [
    Fiddle::TYPE_VOIDP,  # pso : SURFOBJ* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "gdi32")]
extern "system" {
    fn EngCheckAbort(
        pso: *mut SURFOBJ  // SURFOBJ* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll")]
public static extern bool EngCheckAbort(IntPtr pso);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_EngCheckAbort' -Namespace Win32 -PassThru
# $api::EngCheckAbort(pso)
#uselib "GDI32.dll"
#func global EngCheckAbort "EngCheckAbort" sptr
; EngCheckAbort varptr(pso)   ; 戻り値は stat
; pso : SURFOBJ* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "GDI32.dll"
#cfunc global EngCheckAbort "EngCheckAbort" var
; res = EngCheckAbort(pso)
; pso : SURFOBJ* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL EngCheckAbort(SURFOBJ* pso)
#uselib "GDI32.dll"
#cfunc global EngCheckAbort "EngCheckAbort" var
; res = EngCheckAbort(pso)
; pso : SURFOBJ* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procEngCheckAbort = gdi32.NewProc("EngCheckAbort")
)

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

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

typedef EngCheckAbortNative = Int32 Function(Pointer<Void>);
typedef EngCheckAbortDart = int Function(Pointer<Void>);
final EngCheckAbort = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<EngCheckAbortNative, EngCheckAbortDart>('EngCheckAbort');
// pso : SURFOBJ* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EngCheckAbort(
  pso: Pointer   // SURFOBJ* in/out
): BOOL; stdcall;
  external 'GDI32.dll' name 'EngCheckAbort';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "EngCheckAbort"
  c_EngCheckAbort :: Ptr () -> IO CInt
-- pso : SURFOBJ* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let engcheckabort =
  foreign "EngCheckAbort"
    ((ptr void) @-> returning int32_t)
(* pso : SURFOBJ* in/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 ("EngCheckAbort" eng-check-abort :convention :stdcall) :int32
  (pso :pointer))   ; SURFOBJ* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EngCheckAbort = Win32::API::More->new('GDI32',
    'BOOL EngCheckAbort(LPVOID pso)');
# my $ret = $EngCheckAbort->Call($pso);
# pso : SURFOBJ* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型