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

FaxSendDocumentForBroadcastA

関数
同報送信用にファクス文書を複数宛先へ一括送信する。
DLLWINFAX.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL FaxSendDocumentForBroadcastA(
    HANDLE FaxHandle,
    LPCSTR FileName,
    DWORD* FaxJobId,
    PFAX_RECIPIENT_CALLBACKA FaxRecipientCallback,
    void* Context
);

パラメーター

名前方向
FaxHandleHANDLEin
FileNameLPCSTRin
FaxJobIdDWORD*out
FaxRecipientCallbackPFAX_RECIPIENT_CALLBACKAin
Contextvoid*in

戻り値の型: BOOL

各言語での呼び出し定義

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

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

FaxSendDocumentForBroadcastA = ctypes.windll.winfax.FaxSendDocumentForBroadcastA
FaxSendDocumentForBroadcastA.restype = wintypes.BOOL
FaxSendDocumentForBroadcastA.argtypes = [
    wintypes.HANDLE,  # FaxHandle : HANDLE
    wintypes.LPCSTR,  # FileName : LPCSTR
    ctypes.POINTER(wintypes.DWORD),  # FaxJobId : DWORD* out
    ctypes.c_void_p,  # FaxRecipientCallback : PFAX_RECIPIENT_CALLBACKA
    ctypes.POINTER(None),  # Context : void*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINFAX.dll')
FaxSendDocumentForBroadcastA = Fiddle::Function.new(
  lib['FaxSendDocumentForBroadcastA'],
  [
    Fiddle::TYPE_VOIDP,  # FaxHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # FileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # FaxJobId : DWORD* out
    Fiddle::TYPE_VOIDP,  # FaxRecipientCallback : PFAX_RECIPIENT_CALLBACKA
    Fiddle::TYPE_VOIDP,  # Context : void*
  ],
  Fiddle::TYPE_INT)
#[link(name = "winfax")]
extern "system" {
    fn FaxSendDocumentForBroadcastA(
        FaxHandle: *mut core::ffi::c_void,  // HANDLE
        FileName: *const u8,  // LPCSTR
        FaxJobId: *mut u32,  // DWORD* out
        FaxRecipientCallback: *const core::ffi::c_void,  // PFAX_RECIPIENT_CALLBACKA
        Context: *mut ()  // void*
    ) -> 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 FaxSendDocumentForBroadcastA(IntPtr FaxHandle, [MarshalAs(UnmanagedType.LPStr)] string FileName, out uint FaxJobId, IntPtr FaxRecipientCallback, IntPtr Context);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINFAX_FaxSendDocumentForBroadcastA' -Namespace Win32 -PassThru
# $api::FaxSendDocumentForBroadcastA(FaxHandle, FileName, FaxJobId, FaxRecipientCallback, Context)
#uselib "WINFAX.dll"
#func global FaxSendDocumentForBroadcastA "FaxSendDocumentForBroadcastA" sptr, sptr, sptr, sptr, sptr
; FaxSendDocumentForBroadcastA FaxHandle, FileName, varptr(FaxJobId), FaxRecipientCallback, Context   ; 戻り値は stat
; FaxHandle : HANDLE -> "sptr"
; FileName : LPCSTR -> "sptr"
; FaxJobId : DWORD* out -> "sptr"
; FaxRecipientCallback : PFAX_RECIPIENT_CALLBACKA -> "sptr"
; Context : void* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WINFAX.dll"
#cfunc global FaxSendDocumentForBroadcastA "FaxSendDocumentForBroadcastA" sptr, str, var, sptr, sptr
; res = FaxSendDocumentForBroadcastA(FaxHandle, FileName, FaxJobId, FaxRecipientCallback, Context)
; FaxHandle : HANDLE -> "sptr"
; FileName : LPCSTR -> "str"
; FaxJobId : DWORD* out -> "var"
; FaxRecipientCallback : PFAX_RECIPIENT_CALLBACKA -> "sptr"
; Context : void* -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL FaxSendDocumentForBroadcastA(HANDLE FaxHandle, LPCSTR FileName, DWORD* FaxJobId, PFAX_RECIPIENT_CALLBACKA FaxRecipientCallback, void* Context)
#uselib "WINFAX.dll"
#cfunc global FaxSendDocumentForBroadcastA "FaxSendDocumentForBroadcastA" intptr, str, var, intptr, intptr
; res = FaxSendDocumentForBroadcastA(FaxHandle, FileName, FaxJobId, FaxRecipientCallback, Context)
; FaxHandle : HANDLE -> "intptr"
; FileName : LPCSTR -> "str"
; FaxJobId : DWORD* out -> "var"
; FaxRecipientCallback : PFAX_RECIPIENT_CALLBACKA -> "intptr"
; Context : void* -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winfax = windows.NewLazySystemDLL("WINFAX.dll")
	procFaxSendDocumentForBroadcastA = winfax.NewProc("FaxSendDocumentForBroadcastA")
)

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