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

FaxGetPageData

関数
受信中ファクスジョブの先頭ページの画像データを取得する。
DLLWINFAX.dll呼出規約winapi

シグネチャ

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

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

パラメーター

名前方向
FaxHandleHANDLEin
JobIdDWORDin
BufferBYTE**out
BufferSizeDWORD*out
ImageWidthDWORD*out
ImageHeightDWORD*out

戻り値の型: 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 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 方式にも切替可。
出力引数:
; 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 方式にも切替可。
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)。