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

FaxSendDocumentA

関数
FAXで文書を送信する(ANSI版)。
DLLWINFAX.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// WINFAX.dll  (ANSI / -A)
#include <windows.h>

BOOL FaxSendDocumentA(
    HANDLE FaxHandle,
    LPCSTR FileName,
    FAX_JOB_PARAMA* JobParams,
    const FAX_COVERPAGE_INFOA* CoverpageInfo,
    DWORD* FaxJobId
);

パラメーター

名前方向
FaxHandleHANDLEin
FileNameLPCSTRin
JobParamsFAX_JOB_PARAMA*in
CoverpageInfoFAX_COVERPAGE_INFOA*in
FaxJobIdDWORD*out

戻り値の型: BOOL

各言語での呼び出し定義

// WINFAX.dll  (ANSI / -A)
#include <windows.h>

BOOL FaxSendDocumentA(
    HANDLE FaxHandle,
    LPCSTR FileName,
    FAX_JOB_PARAMA* JobParams,
    const FAX_COVERPAGE_INFOA* CoverpageInfo,
    DWORD* FaxJobId
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINFAX.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool FaxSendDocumentA(
    IntPtr FaxHandle,   // HANDLE
    [MarshalAs(UnmanagedType.LPStr)] string FileName,   // LPCSTR
    IntPtr JobParams,   // FAX_JOB_PARAMA*
    IntPtr CoverpageInfo,   // FAX_COVERPAGE_INFOA*
    out uint FaxJobId   // DWORD* out
);
<DllImport("WINFAX.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FaxSendDocumentA(
    FaxHandle As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPStr)> FileName As String,   ' LPCSTR
    JobParams As IntPtr,   ' FAX_JOB_PARAMA*
    CoverpageInfo As IntPtr,   ' FAX_COVERPAGE_INFOA*
    <Out> ByRef FaxJobId As UInteger   ' DWORD* out
) As Boolean
End Function
' FaxHandle : HANDLE
' FileName : LPCSTR
' JobParams : FAX_JOB_PARAMA*
' CoverpageInfo : FAX_COVERPAGE_INFOA*
' FaxJobId : DWORD* out
Declare PtrSafe Function FaxSendDocumentA Lib "winfax" ( _
    ByVal FaxHandle As LongPtr, _
    ByVal FileName As String, _
    ByVal JobParams As LongPtr, _
    ByVal CoverpageInfo As LongPtr, _
    ByRef FaxJobId As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FaxSendDocumentA = ctypes.windll.winfax.FaxSendDocumentA
FaxSendDocumentA.restype = wintypes.BOOL
FaxSendDocumentA.argtypes = [
    wintypes.HANDLE,  # FaxHandle : HANDLE
    wintypes.LPCSTR,  # FileName : LPCSTR
    ctypes.c_void_p,  # JobParams : FAX_JOB_PARAMA*
    ctypes.c_void_p,  # CoverpageInfo : FAX_COVERPAGE_INFOA*
    ctypes.POINTER(wintypes.DWORD),  # FaxJobId : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINFAX.dll')
FaxSendDocumentA = Fiddle::Function.new(
  lib['FaxSendDocumentA'],
  [
    Fiddle::TYPE_VOIDP,  # FaxHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # FileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # JobParams : FAX_JOB_PARAMA*
    Fiddle::TYPE_VOIDP,  # CoverpageInfo : FAX_COVERPAGE_INFOA*
    Fiddle::TYPE_VOIDP,  # FaxJobId : DWORD* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "winfax")]
extern "system" {
    fn FaxSendDocumentA(
        FaxHandle: *mut core::ffi::c_void,  // HANDLE
        FileName: *const u8,  // LPCSTR
        JobParams: *mut FAX_JOB_PARAMA,  // FAX_JOB_PARAMA*
        CoverpageInfo: *const FAX_COVERPAGE_INFOA,  // FAX_COVERPAGE_INFOA*
        FaxJobId: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINFAX.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool FaxSendDocumentA(IntPtr FaxHandle, [MarshalAs(UnmanagedType.LPStr)] string FileName, IntPtr JobParams, IntPtr CoverpageInfo, out uint FaxJobId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINFAX_FaxSendDocumentA' -Namespace Win32 -PassThru
# $api::FaxSendDocumentA(FaxHandle, FileName, JobParams, CoverpageInfo, FaxJobId)
#uselib "WINFAX.dll"
#func global FaxSendDocumentA "FaxSendDocumentA" sptr, sptr, sptr, sptr, sptr
; FaxSendDocumentA FaxHandle, FileName, varptr(JobParams), varptr(CoverpageInfo), varptr(FaxJobId)   ; 戻り値は stat
; FaxHandle : HANDLE -> "sptr"
; FileName : LPCSTR -> "sptr"
; JobParams : FAX_JOB_PARAMA* -> "sptr"
; CoverpageInfo : FAX_COVERPAGE_INFOA* -> "sptr"
; FaxJobId : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WINFAX.dll"
#cfunc global FaxSendDocumentA "FaxSendDocumentA" sptr, str, var, var, var
; res = FaxSendDocumentA(FaxHandle, FileName, JobParams, CoverpageInfo, FaxJobId)
; FaxHandle : HANDLE -> "sptr"
; FileName : LPCSTR -> "str"
; JobParams : FAX_JOB_PARAMA* -> "var"
; CoverpageInfo : FAX_COVERPAGE_INFOA* -> "var"
; FaxJobId : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL FaxSendDocumentA(HANDLE FaxHandle, LPCSTR FileName, FAX_JOB_PARAMA* JobParams, FAX_COVERPAGE_INFOA* CoverpageInfo, DWORD* FaxJobId)
#uselib "WINFAX.dll"
#cfunc global FaxSendDocumentA "FaxSendDocumentA" intptr, str, var, var, var
; res = FaxSendDocumentA(FaxHandle, FileName, JobParams, CoverpageInfo, FaxJobId)
; FaxHandle : HANDLE -> "intptr"
; FileName : LPCSTR -> "str"
; JobParams : FAX_JOB_PARAMA* -> "var"
; CoverpageInfo : FAX_COVERPAGE_INFOA* -> "var"
; FaxJobId : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winfax = windows.NewLazySystemDLL("WINFAX.dll")
	procFaxSendDocumentA = winfax.NewProc("FaxSendDocumentA")
)

// FaxHandle (HANDLE), FileName (LPCSTR), JobParams (FAX_JOB_PARAMA*), CoverpageInfo (FAX_COVERPAGE_INFOA*), FaxJobId (DWORD* out)
r1, _, err := procFaxSendDocumentA.Call(
	uintptr(FaxHandle),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(FileName))),
	uintptr(JobParams),
	uintptr(CoverpageInfo),
	uintptr(FaxJobId),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function FaxSendDocumentA(
  FaxHandle: THandle;   // HANDLE
  FileName: PAnsiChar;   // LPCSTR
  JobParams: Pointer;   // FAX_JOB_PARAMA*
  CoverpageInfo: Pointer;   // FAX_COVERPAGE_INFOA*
  FaxJobId: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'WINFAX.dll' name 'FaxSendDocumentA';
result := DllCall("WINFAX\FaxSendDocumentA"
    , "Ptr", FaxHandle   ; HANDLE
    , "AStr", FileName   ; LPCSTR
    , "Ptr", JobParams   ; FAX_JOB_PARAMA*
    , "Ptr", CoverpageInfo   ; FAX_COVERPAGE_INFOA*
    , "Ptr", FaxJobId   ; DWORD* out
    , "Int")   ; return: BOOL
●FaxSendDocumentA(FaxHandle, FileName, JobParams, CoverpageInfo, FaxJobId) = DLL("WINFAX.dll", "bool FaxSendDocumentA(void*, char*, void*, void*, void*)")
# 呼び出し: FaxSendDocumentA(FaxHandle, FileName, JobParams, CoverpageInfo, FaxJobId)
# FaxHandle : HANDLE -> "void*"
# FileName : LPCSTR -> "char*"
# JobParams : FAX_JOB_PARAMA* -> "void*"
# CoverpageInfo : FAX_COVERPAGE_INFOA* -> "void*"
# FaxJobId : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。