FaxGetPageData

関数

受信中ファクスジョブの先頭ページの画像データを取得する。

DLLWINFAX.dll呼出規約winapi

シグネチャ

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

BOOL FaxGetPageData(
    HANDLE FaxHandle,
    DWORD JobId,
    BYTE** Buffer,
    DWORD* BufferSize,
    DWORD* ImageWidth,
    DWORD* ImageHeight
);

パラメーター

名前	型	方向	説明
FaxHandle	HANDLE	in	FAXサーバー接続のハンドルを指定する。
JobId	DWORD	in	ページデータを取得する対象のFAXジョブIDを指定する。
Buffer	BYTE**	out	ページ画像データを受け取るバッファポインタを返すポインタ。FaxFreeBufferで解放する。
BufferSize	DWORD*	out	返された画像データのバイトサイズを受け取るDWORDへのポインタを指定する。
ImageWidth	DWORD*	out	画像の幅(ピクセル)を受け取るDWORDへのポインタを指定する。出力専用。
ImageHeight	DWORD*	out	画像の高さ(ピクセル)を受け取るDWORDへのポインタを指定する。出力専用。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL FaxGetPageData(
    HANDLE FaxHandle,
    DWORD JobId,
    BYTE** Buffer,
    DWORD* BufferSize,
    DWORD* ImageWidth,
    DWORD* ImageHeight
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINFAX.dll", ExactSpelling = true)]
static extern bool FaxGetPageData(
    IntPtr FaxHandle,   // HANDLE
    uint JobId,   // DWORD
    IntPtr Buffer,   // BYTE** out
    out uint BufferSize,   // DWORD* out
    out uint ImageWidth,   // DWORD* out
    out uint ImageHeight   // DWORD* out
);

<DllImport("WINFAX.dll", ExactSpelling:=True)>
Public Shared Function FaxGetPageData(
    FaxHandle As IntPtr,   ' HANDLE
    JobId As UInteger,   ' DWORD
    Buffer As IntPtr,   ' BYTE** out
    <Out> ByRef BufferSize As UInteger,   ' DWORD* out
    <Out> ByRef ImageWidth As UInteger,   ' DWORD* out
    <Out> ByRef ImageHeight As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' FaxHandle : HANDLE
' JobId : DWORD
' Buffer : BYTE** out
' BufferSize : DWORD* out
' ImageWidth : DWORD* out
' ImageHeight : DWORD* out
Declare PtrSafe Function FaxGetPageData Lib "winfax" ( _
    ByVal FaxHandle As LongPtr, _
    ByVal JobId As Long, _
    ByVal Buffer As LongPtr, _
    ByRef BufferSize As Long, _
    ByRef ImageWidth As Long, _
    ByRef ImageHeight As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

FaxGetPageData = ctypes.windll.winfax.FaxGetPageData
FaxGetPageData.restype = wintypes.BOOL
FaxGetPageData.argtypes = [
    wintypes.HANDLE,  # FaxHandle : HANDLE
    wintypes.DWORD,  # JobId : DWORD
    ctypes.c_void_p,  # Buffer : BYTE** out
    ctypes.POINTER(wintypes.DWORD),  # BufferSize : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # ImageWidth : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # ImageHeight : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINFAX.dll')
FaxGetPageData = Fiddle::Function.new(
  lib['FaxGetPageData'],
  [
    Fiddle::TYPE_VOIDP,  # FaxHandle : HANDLE
    -Fiddle::TYPE_INT,  # JobId : DWORD
    Fiddle::TYPE_VOIDP,  # Buffer : BYTE** out
    Fiddle::TYPE_VOIDP,  # BufferSize : DWORD* out
    Fiddle::TYPE_VOIDP,  # ImageWidth : DWORD* out
    Fiddle::TYPE_VOIDP,  # ImageHeight : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "winfax")]
extern "system" {
    fn FaxGetPageData(
        FaxHandle: *mut core::ffi::c_void,  // HANDLE
        JobId: u32,  // DWORD
        Buffer: *mut *mut u8,  // BYTE** out
        BufferSize: *mut u32,  // DWORD* out
        ImageWidth: *mut u32,  // DWORD* out
        ImageHeight: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINFAX.dll")]
public static extern bool FaxGetPageData(IntPtr FaxHandle, uint JobId, IntPtr Buffer, out uint BufferSize, out uint ImageWidth, out uint ImageHeight);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINFAX_FaxGetPageData' -Namespace Win32 -PassThru
# $api::FaxGetPageData(FaxHandle, JobId, Buffer, BufferSize, ImageWidth, ImageHeight)

#uselib "WINFAX.dll"
#func global FaxGetPageData "FaxGetPageData" sptr, sptr, sptr, sptr, sptr, sptr
; FaxGetPageData FaxHandle, JobId, varptr(Buffer), varptr(BufferSize), varptr(ImageWidth), varptr(ImageHeight)   ; 戻り値は stat
; FaxHandle : HANDLE -> "sptr"
; JobId : DWORD -> "sptr"
; Buffer : BYTE** out -> "sptr"
; BufferSize : DWORD* out -> "sptr"
; ImageWidth : DWORD* out -> "sptr"
; ImageHeight : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WINFAX.dll"
#cfunc global FaxGetPageData "FaxGetPageData" sptr, int, var, var, var, var
; res = FaxGetPageData(FaxHandle, JobId, Buffer, BufferSize, ImageWidth, ImageHeight)
; FaxHandle : HANDLE -> "sptr"
; JobId : DWORD -> "int"
; Buffer : BYTE** out -> "var"
; BufferSize : DWORD* out -> "var"
; ImageWidth : DWORD* out -> "var"
; ImageHeight : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WINFAX.dll"
#cfunc global FaxGetPageData "FaxGetPageData" sptr, int, sptr, sptr, sptr, sptr
; res = FaxGetPageData(FaxHandle, JobId, varptr(Buffer), varptr(BufferSize), varptr(ImageWidth), varptr(ImageHeight))
; FaxHandle : HANDLE -> "sptr"
; JobId : DWORD -> "int"
; Buffer : BYTE** out -> "sptr"
; BufferSize : DWORD* out -> "sptr"
; ImageWidth : DWORD* out -> "sptr"
; ImageHeight : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; BOOL FaxGetPageData(HANDLE FaxHandle, DWORD JobId, BYTE** Buffer, DWORD* BufferSize, DWORD* ImageWidth, DWORD* ImageHeight)
#uselib "WINFAX.dll"
#cfunc global FaxGetPageData "FaxGetPageData" intptr, int, var, var, var, var
; res = FaxGetPageData(FaxHandle, JobId, Buffer, BufferSize, ImageWidth, ImageHeight)
; FaxHandle : HANDLE -> "intptr"
; JobId : DWORD -> "int"
; Buffer : BYTE** out -> "var"
; BufferSize : DWORD* out -> "var"
; ImageWidth : DWORD* out -> "var"
; ImageHeight : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL FaxGetPageData(HANDLE FaxHandle, DWORD JobId, BYTE** Buffer, DWORD* BufferSize, DWORD* ImageWidth, DWORD* ImageHeight)
#uselib "WINFAX.dll"
#cfunc global FaxGetPageData "FaxGetPageData" intptr, int, intptr, intptr, intptr, intptr
; res = FaxGetPageData(FaxHandle, JobId, varptr(Buffer), varptr(BufferSize), varptr(ImageWidth), varptr(ImageHeight))
; FaxHandle : HANDLE -> "intptr"
; JobId : DWORD -> "int"
; Buffer : BYTE** out -> "intptr"
; BufferSize : DWORD* out -> "intptr"
; ImageWidth : DWORD* out -> "intptr"
; ImageHeight : DWORD* out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winfax = windows.NewLazySystemDLL("WINFAX.dll")
	procFaxGetPageData = winfax.NewProc("FaxGetPageData")
)

// FaxHandle (HANDLE), JobId (DWORD), Buffer (BYTE** out), BufferSize (DWORD* out), ImageWidth (DWORD* out), ImageHeight (DWORD* out)
r1, _, err := procFaxGetPageData.Call(
	uintptr(FaxHandle),
	uintptr(JobId),
	uintptr(Buffer),
	uintptr(BufferSize),
	uintptr(ImageWidth),
	uintptr(ImageHeight),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function FaxGetPageData(
  FaxHandle: THandle;   // HANDLE
  JobId: DWORD;   // DWORD
  Buffer: Pointer;   // BYTE** out
  BufferSize: Pointer;   // DWORD* out
  ImageWidth: Pointer;   // DWORD* out
  ImageHeight: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'WINFAX.dll' name 'FaxGetPageData';

result := DllCall("WINFAX\FaxGetPageData"
    , "Ptr", FaxHandle   ; HANDLE
    , "UInt", JobId   ; DWORD
    , "Ptr", Buffer   ; BYTE** out
    , "Ptr", BufferSize   ; DWORD* out
    , "Ptr", ImageWidth   ; DWORD* out
    , "Ptr", ImageHeight   ; DWORD* out
    , "Int")   ; return: BOOL

●FaxGetPageData(FaxHandle, JobId, Buffer, BufferSize, ImageWidth, ImageHeight) = DLL("WINFAX.dll", "bool FaxGetPageData(void*, dword, void*, void*, void*, void*)")
# 呼び出し: FaxGetPageData(FaxHandle, JobId, Buffer, BufferSize, ImageWidth, ImageHeight)
# FaxHandle : HANDLE -> "void*"
# JobId : DWORD -> "dword"
# Buffer : BYTE** out -> "void*"
# BufferSize : DWORD* out -> "void*"
# ImageWidth : DWORD* out -> "void*"
# ImageHeight : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "winfax" fn FaxGetPageData(
    FaxHandle: ?*anyopaque, // HANDLE
    JobId: u32, // DWORD
    Buffer: [*c][*c]u8, // BYTE** out
    BufferSize: [*c]u32, // DWORD* out
    ImageWidth: [*c]u32, // DWORD* out
    ImageHeight: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;

proc FaxGetPageData(
    FaxHandle: pointer,  # HANDLE
    JobId: uint32,  # DWORD
    Buffer: ptr uint8,  # BYTE** out
    BufferSize: ptr uint32,  # DWORD* out
    ImageWidth: ptr uint32,  # DWORD* out
    ImageHeight: ptr uint32  # DWORD* out
): int32 {.importc: "FaxGetPageData", stdcall, dynlib: "WINFAX.dll".}

pragma(lib, "winfax");
extern(Windows)
int FaxGetPageData(
    void* FaxHandle,   // HANDLE
    uint JobId,   // DWORD
    ubyte** Buffer,   // BYTE** out
    uint* BufferSize,   // DWORD* out
    uint* ImageWidth,   // DWORD* out
    uint* ImageHeight   // DWORD* out
);

ccall((:FaxGetPageData, "WINFAX.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, Ptr{UInt8}, Ptr{UInt32}, Ptr{UInt32}, Ptr{UInt32}),
      FaxHandle, JobId, Buffer, BufferSize, ImageWidth, ImageHeight)
# FaxHandle : HANDLE -> Ptr{Cvoid}
# JobId : DWORD -> UInt32
# Buffer : BYTE** out -> Ptr{UInt8}
# BufferSize : DWORD* out -> Ptr{UInt32}
# ImageWidth : DWORD* out -> Ptr{UInt32}
# ImageHeight : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
int32_t FaxGetPageData(
    void* FaxHandle,
    uint32_t JobId,
    uint8_t** Buffer,
    uint32_t* BufferSize,
    uint32_t* ImageWidth,
    uint32_t* ImageHeight);
]]
local winfax = ffi.load("winfax")
-- winfax.FaxGetPageData(FaxHandle, JobId, Buffer, BufferSize, ImageWidth, ImageHeight)
-- FaxHandle : HANDLE
-- JobId : DWORD
-- Buffer : BYTE** out
-- BufferSize : DWORD* out
-- ImageWidth : DWORD* out
-- ImageHeight : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('WINFAX.dll');
const FaxGetPageData = lib.func('__stdcall', 'FaxGetPageData', 'int32_t', ['void *', 'uint32_t', 'uint8_t *', 'uint32_t *', 'uint32_t *', 'uint32_t *']);
// FaxGetPageData(FaxHandle, JobId, Buffer, BufferSize, ImageWidth, ImageHeight)
// FaxHandle : HANDLE -> 'void *'
// JobId : DWORD -> 'uint32_t'
// Buffer : BYTE** out -> 'uint8_t *'
// BufferSize : DWORD* out -> 'uint32_t *'
// ImageWidth : DWORD* out -> 'uint32_t *'
// ImageHeight : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("WINFAX.dll", {
  FaxGetPageData: { parameters: ["pointer", "u32", "pointer", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.FaxGetPageData(FaxHandle, JobId, Buffer, BufferSize, ImageWidth, ImageHeight)
// FaxHandle : HANDLE -> "pointer"
// JobId : DWORD -> "u32"
// Buffer : BYTE** out -> "pointer"
// BufferSize : DWORD* out -> "pointer"
// ImageWidth : DWORD* out -> "pointer"
// ImageHeight : DWORD* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t FaxGetPageData(
    void* FaxHandle,
    uint32_t JobId,
    uint8_t** Buffer,
    uint32_t* BufferSize,
    uint32_t* ImageWidth,
    uint32_t* ImageHeight);
C, "WINFAX.dll");
// $ffi->FaxGetPageData(FaxHandle, JobId, Buffer, BufferSize, ImageWidth, ImageHeight);
// FaxHandle : HANDLE
// JobId : DWORD
// Buffer : BYTE** out
// BufferSize : DWORD* out
// ImageWidth : DWORD* out
// ImageHeight : DWORD* 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 Winfax extends StdCallLibrary {
    Winfax INSTANCE = Native.load("winfax", Winfax.class);
    boolean FaxGetPageData(
        Pointer FaxHandle,   // HANDLE
        int JobId,   // DWORD
        Pointer Buffer,   // BYTE** out
        IntByReference BufferSize,   // DWORD* out
        IntByReference ImageWidth,   // DWORD* out
        IntByReference ImageHeight   // DWORD* out
    );
}

@[Link("winfax")]
lib LibWINFAX
  fun FaxGetPageData = FaxGetPageData(
    FaxHandle : Void*,   # HANDLE
    JobId : UInt32,   # DWORD
    Buffer : UInt8**,   # BYTE** out
    BufferSize : UInt32*,   # DWORD* out
    ImageWidth : UInt32*,   # DWORD* out
    ImageHeight : UInt32*   # DWORD* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef FaxGetPageDataNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Uint8>, Pointer<Uint32>, Pointer<Uint32>, Pointer<Uint32>);
typedef FaxGetPageDataDart = int Function(Pointer<Void>, int, Pointer<Uint8>, Pointer<Uint32>, Pointer<Uint32>, Pointer<Uint32>);
final FaxGetPageData = DynamicLibrary.open('WINFAX.dll')
    .lookupFunction<FaxGetPageDataNative, FaxGetPageDataDart>('FaxGetPageData');
// FaxHandle : HANDLE -> Pointer<Void>
// JobId : DWORD -> Uint32
// Buffer : BYTE** out -> Pointer<Uint8>
// BufferSize : DWORD* out -> Pointer<Uint32>
// ImageWidth : DWORD* out -> Pointer<Uint32>
// ImageHeight : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function FaxGetPageData(
  FaxHandle: THandle;   // HANDLE
  JobId: DWORD;   // DWORD
  Buffer: Pointer;   // BYTE** out
  BufferSize: Pointer;   // DWORD* out
  ImageWidth: Pointer;   // DWORD* out
  ImageHeight: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'WINFAX.dll' name 'FaxGetPageData';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FaxGetPageData"
  c_FaxGetPageData :: Ptr () -> Word32 -> Ptr Word8 -> Ptr Word32 -> Ptr Word32 -> Ptr Word32 -> IO CInt
-- FaxHandle : HANDLE -> Ptr ()
-- JobId : DWORD -> Word32
-- Buffer : BYTE** out -> Ptr Word8
-- BufferSize : DWORD* out -> Ptr Word32
-- ImageWidth : DWORD* out -> Ptr Word32
-- ImageHeight : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let faxgetpagedata =
  foreign "FaxGetPageData"
    ((ptr void) @-> uint32_t @-> (ptr uint8_t) @-> (ptr uint32_t) @-> (ptr uint32_t) @-> (ptr uint32_t) @-> returning int32_t)
(* FaxHandle : HANDLE -> (ptr void) *)
(* JobId : DWORD -> uint32_t *)
(* Buffer : BYTE** out -> (ptr uint8_t) *)
(* BufferSize : DWORD* out -> (ptr uint32_t) *)
(* ImageWidth : DWORD* out -> (ptr uint32_t) *)
(* ImageHeight : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library winfax (t "WINFAX.dll"))
(cffi:use-foreign-library winfax)

(cffi:defcfun ("FaxGetPageData" fax-get-page-data :convention :stdcall) :int32
  (fax-handle :pointer)   ; HANDLE
  (job-id :uint32)   ; DWORD
  (buffer :pointer)   ; BYTE** out
  (buffer-size :pointer)   ; DWORD* out
  (image-width :pointer)   ; DWORD* out
  (image-height :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $FaxGetPageData = Win32::API::More->new('WINFAX',
    'BOOL FaxGetPageData(HANDLE FaxHandle, DWORD JobId, LPVOID Buffer, LPVOID BufferSize, LPVOID ImageWidth, LPVOID ImageHeight)');
# my $ret = $FaxGetPageData->Call($FaxHandle, $JobId, $Buffer, $BufferSize, $ImageWidth, $ImageHeight);
# FaxHandle : HANDLE -> HANDLE
# JobId : DWORD -> DWORD
# Buffer : BYTE** out -> LPVOID
# BufferSize : DWORD* out -> LPVOID
# ImageWidth : DWORD* out -> LPVOID
# ImageHeight : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。