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

FaxSendDocumentW

関数
指定したファイルをファクス文書として送信ジョブに登録する。
DLLWINFAX.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// WINFAX.dll  (Unicode / -W)
#include <windows.h>

BOOL FaxSendDocumentW(
    HANDLE FaxHandle,
    LPCWSTR FileName,
    FAX_JOB_PARAMW* JobParams,
    const FAX_COVERPAGE_INFOW* CoverpageInfo,
    DWORD* FaxJobId
);

パラメーター

名前方向
FaxHandleHANDLEin
FileNameLPCWSTRin
JobParamsFAX_JOB_PARAMW*in
CoverpageInfoFAX_COVERPAGE_INFOW*in
FaxJobIdDWORD*out

戻り値の型: BOOL

各言語での呼び出し定義

// WINFAX.dll  (Unicode / -W)
#include <windows.h>

BOOL FaxSendDocumentW(
    HANDLE FaxHandle,
    LPCWSTR FileName,
    FAX_JOB_PARAMW* JobParams,
    const FAX_COVERPAGE_INFOW* CoverpageInfo,
    DWORD* FaxJobId
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINFAX.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool FaxSendDocumentW(
    IntPtr FaxHandle,   // HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string FileName,   // LPCWSTR
    IntPtr JobParams,   // FAX_JOB_PARAMW*
    IntPtr CoverpageInfo,   // FAX_COVERPAGE_INFOW*
    out uint FaxJobId   // DWORD* out
);
<DllImport("WINFAX.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FaxSendDocumentW(
    FaxHandle As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> FileName As String,   ' LPCWSTR
    JobParams As IntPtr,   ' FAX_JOB_PARAMW*
    CoverpageInfo As IntPtr,   ' FAX_COVERPAGE_INFOW*
    <Out> ByRef FaxJobId As UInteger   ' DWORD* out
) As Boolean
End Function
' FaxHandle : HANDLE
' FileName : LPCWSTR
' JobParams : FAX_JOB_PARAMW*
' CoverpageInfo : FAX_COVERPAGE_INFOW*
' FaxJobId : DWORD* out
Declare PtrSafe Function FaxSendDocumentW Lib "winfax" ( _
    ByVal FaxHandle As LongPtr, _
    ByVal FileName As LongPtr, _
    ByVal JobParams As LongPtr, _
    ByVal CoverpageInfo As LongPtr, _
    ByRef FaxJobId As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FaxSendDocumentW = ctypes.windll.winfax.FaxSendDocumentW
FaxSendDocumentW.restype = wintypes.BOOL
FaxSendDocumentW.argtypes = [
    wintypes.HANDLE,  # FaxHandle : HANDLE
    wintypes.LPCWSTR,  # FileName : LPCWSTR
    ctypes.c_void_p,  # JobParams : FAX_JOB_PARAMW*
    ctypes.c_void_p,  # CoverpageInfo : FAX_COVERPAGE_INFOW*
    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')
FaxSendDocumentW = Fiddle::Function.new(
  lib['FaxSendDocumentW'],
  [
    Fiddle::TYPE_VOIDP,  # FaxHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # FileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # JobParams : FAX_JOB_PARAMW*
    Fiddle::TYPE_VOIDP,  # CoverpageInfo : FAX_COVERPAGE_INFOW*
    Fiddle::TYPE_VOIDP,  # FaxJobId : DWORD* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "winfax")]
extern "system" {
    fn FaxSendDocumentW(
        FaxHandle: *mut core::ffi::c_void,  // HANDLE
        FileName: *const u16,  // LPCWSTR
        JobParams: *mut FAX_JOB_PARAMW,  // FAX_JOB_PARAMW*
        CoverpageInfo: *const FAX_COVERPAGE_INFOW,  // FAX_COVERPAGE_INFOW*
        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.Unicode, SetLastError = true)]
public static extern bool FaxSendDocumentW(IntPtr FaxHandle, [MarshalAs(UnmanagedType.LPWStr)] string FileName, IntPtr JobParams, IntPtr CoverpageInfo, out uint FaxJobId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINFAX_FaxSendDocumentW' -Namespace Win32 -PassThru
# $api::FaxSendDocumentW(FaxHandle, FileName, JobParams, CoverpageInfo, FaxJobId)
#uselib "WINFAX.dll"
#func global FaxSendDocumentW "FaxSendDocumentW" wptr, wptr, wptr, wptr, wptr
; FaxSendDocumentW FaxHandle, FileName, varptr(JobParams), varptr(CoverpageInfo), varptr(FaxJobId)   ; 戻り値は stat
; FaxHandle : HANDLE -> "wptr"
; FileName : LPCWSTR -> "wptr"
; JobParams : FAX_JOB_PARAMW* -> "wptr"
; CoverpageInfo : FAX_COVERPAGE_INFOW* -> "wptr"
; FaxJobId : DWORD* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WINFAX.dll"
#cfunc global FaxSendDocumentW "FaxSendDocumentW" sptr, wstr, var, var, var
; res = FaxSendDocumentW(FaxHandle, FileName, JobParams, CoverpageInfo, FaxJobId)
; FaxHandle : HANDLE -> "sptr"
; FileName : LPCWSTR -> "wstr"
; JobParams : FAX_JOB_PARAMW* -> "var"
; CoverpageInfo : FAX_COVERPAGE_INFOW* -> "var"
; FaxJobId : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL FaxSendDocumentW(HANDLE FaxHandle, LPCWSTR FileName, FAX_JOB_PARAMW* JobParams, FAX_COVERPAGE_INFOW* CoverpageInfo, DWORD* FaxJobId)
#uselib "WINFAX.dll"
#cfunc global FaxSendDocumentW "FaxSendDocumentW" intptr, wstr, var, var, var
; res = FaxSendDocumentW(FaxHandle, FileName, JobParams, CoverpageInfo, FaxJobId)
; FaxHandle : HANDLE -> "intptr"
; FileName : LPCWSTR -> "wstr"
; JobParams : FAX_JOB_PARAMW* -> "var"
; CoverpageInfo : FAX_COVERPAGE_INFOW* -> "var"
; FaxJobId : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winfax = windows.NewLazySystemDLL("WINFAX.dll")
	procFaxSendDocumentW = winfax.NewProc("FaxSendDocumentW")
)

// FaxHandle (HANDLE), FileName (LPCWSTR), JobParams (FAX_JOB_PARAMW*), CoverpageInfo (FAX_COVERPAGE_INFOW*), FaxJobId (DWORD* out)
r1, _, err := procFaxSendDocumentW.Call(
	uintptr(FaxHandle),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(FileName))),
	uintptr(JobParams),
	uintptr(CoverpageInfo),
	uintptr(FaxJobId),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function FaxSendDocumentW(
  FaxHandle: THandle;   // HANDLE
  FileName: PWideChar;   // LPCWSTR
  JobParams: Pointer;   // FAX_JOB_PARAMW*
  CoverpageInfo: Pointer;   // FAX_COVERPAGE_INFOW*
  FaxJobId: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'WINFAX.dll' name 'FaxSendDocumentW';
result := DllCall("WINFAX\FaxSendDocumentW"
    , "Ptr", FaxHandle   ; HANDLE
    , "WStr", FileName   ; LPCWSTR
    , "Ptr", JobParams   ; FAX_JOB_PARAMW*
    , "Ptr", CoverpageInfo   ; FAX_COVERPAGE_INFOW*
    , "Ptr", FaxJobId   ; DWORD* out
    , "Int")   ; return: BOOL
●FaxSendDocumentW(FaxHandle, FileName, JobParams, CoverpageInfo, FaxJobId) = DLL("WINFAX.dll", "bool FaxSendDocumentW(void*, char*, void*, void*, void*)")
# 呼び出し: FaxSendDocumentW(FaxHandle, FileName, JobParams, CoverpageInfo, FaxJobId)
# FaxHandle : HANDLE -> "void*"
# FileName : LPCWSTR -> "char*"
# JobParams : FAX_JOB_PARAMW* -> "void*"
# CoverpageInfo : FAX_COVERPAGE_INFOW* -> "void*"
# FaxJobId : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。