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

FaxAbort

関数
指定したファクスジョブを中止する。
DLLWINFAX.dll呼出規約winapi

シグネチャ

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

BOOL FaxAbort(
    HANDLE FaxHandle,
    DWORD JobId
);

パラメーター

名前方向説明
FaxHandleHANDLEinFAXサーバー接続のハンドルを指定する。
JobIdDWORDin中止する対象のFAXジョブIDを指定する。送受信中のジョブを停止する。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL FaxAbort(
    HANDLE FaxHandle,
    DWORD JobId
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINFAX.dll", ExactSpelling = true)]
static extern bool FaxAbort(
    IntPtr FaxHandle,   // HANDLE
    uint JobId   // DWORD
);
<DllImport("WINFAX.dll", ExactSpelling:=True)>
Public Shared Function FaxAbort(
    FaxHandle As IntPtr,   ' HANDLE
    JobId As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' FaxHandle : HANDLE
' JobId : DWORD
Declare PtrSafe Function FaxAbort Lib "winfax" ( _
    ByVal FaxHandle As LongPtr, _
    ByVal JobId As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FaxAbort = ctypes.windll.winfax.FaxAbort
FaxAbort.restype = wintypes.BOOL
FaxAbort.argtypes = [
    wintypes.HANDLE,  # FaxHandle : HANDLE
    wintypes.DWORD,  # JobId : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	winfax = windows.NewLazySystemDLL("WINFAX.dll")
	procFaxAbort = winfax.NewProc("FaxAbort")
)

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

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

typedef FaxAbortNative = Int32 Function(Pointer<Void>, Uint32);
typedef FaxAbortDart = int Function(Pointer<Void>, int);
final FaxAbort = DynamicLibrary.open('WINFAX.dll')
    .lookupFunction<FaxAbortNative, FaxAbortDart>('FaxAbort');
// FaxHandle : HANDLE -> Pointer<Void>
// JobId : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FaxAbort(
  FaxHandle: THandle;   // HANDLE
  JobId: DWORD   // DWORD
): BOOL; stdcall;
  external 'WINFAX.dll' name 'FaxAbort';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FaxAbort"
  c_FaxAbort :: Ptr () -> Word32 -> IO CInt
-- FaxHandle : HANDLE -> Ptr ()
-- JobId : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let faxabort =
  foreign "FaxAbort"
    ((ptr void) @-> uint32_t @-> returning int32_t)
(* FaxHandle : HANDLE -> (ptr void) *)
(* JobId : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winfax (t "WINFAX.dll"))
(cffi:use-foreign-library winfax)

(cffi:defcfun ("FaxAbort" fax-abort :convention :stdcall) :int32
  (fax-handle :pointer)   ; HANDLE
  (job-id :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FaxAbort = Win32::API::More->new('WINFAX',
    'BOOL FaxAbort(HANDLE FaxHandle, DWORD JobId)');
# my $ret = $FaxAbort->Call($FaxHandle, $JobId);
# FaxHandle : HANDLE -> HANDLE
# JobId : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。