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
);

パラメーター

名前方向説明
FaxHandleHANDLEinFAXサーバー接続のハンドルを指定する。
FileNameLPCWSTRin送信する文書ファイルのパス(Unicode)を指定する。TIFF等の送信可能形式を指す。
JobParamsFAX_JOB_PARAMW*in送信ジョブのパラメータを格納したFAX_JOB_PARAMW構造体へのポインタを指定する。
CoverpageInfoFAX_COVERPAGE_INFOW*inカバーページ情報のFAX_COVERPAGE_INFOW構造体へのポインタを指定する。NULL可。
FaxJobIdDWORD*out作成された送信ジョブのIDを受け取るDWORDへのポインタを指定する。出力専用。

戻り値の型: 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 <MarshalAs(UnmanagedType.Bool)> 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 版の利用を推奨。
const std = @import("std");

extern "winfax" fn FaxSendDocumentW(
    FaxHandle: ?*anyopaque, // HANDLE
    FileName: [*c]const u16, // LPCWSTR
    JobParams: [*c]FAX_JOB_PARAMW, // FAX_JOB_PARAMW*
    CoverpageInfo: [*c]FAX_COVERPAGE_INFOW, // FAX_COVERPAGE_INFOW*
    FaxJobId: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc FaxSendDocumentW(
    FaxHandle: pointer,  # HANDLE
    FileName: WideCString,  # LPCWSTR
    JobParams: ptr FAX_JOB_PARAMW,  # FAX_JOB_PARAMW*
    CoverpageInfo: ptr FAX_COVERPAGE_INFOW,  # FAX_COVERPAGE_INFOW*
    FaxJobId: ptr uint32  # DWORD* out
): int32 {.importc: "FaxSendDocumentW", stdcall, dynlib: "WINFAX.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "winfax");
extern(Windows)
int FaxSendDocumentW(
    void* FaxHandle,   // HANDLE
    const(wchar)* FileName,   // LPCWSTR
    FAX_JOB_PARAMW* JobParams,   // FAX_JOB_PARAMW*
    FAX_COVERPAGE_INFOW* CoverpageInfo,   // FAX_COVERPAGE_INFOW*
    uint* FaxJobId   // DWORD* out
);
ccall((:FaxSendDocumentW, "WINFAX.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cwstring, Ptr{FAX_JOB_PARAMW}, Ptr{FAX_COVERPAGE_INFOW}, Ptr{UInt32}),
      FaxHandle, FileName, JobParams, CoverpageInfo, FaxJobId)
# FaxHandle : HANDLE -> Ptr{Cvoid}
# FileName : LPCWSTR -> Cwstring
# JobParams : FAX_JOB_PARAMW* -> Ptr{FAX_JOB_PARAMW}
# CoverpageInfo : FAX_COVERPAGE_INFOW* -> Ptr{FAX_COVERPAGE_INFOW}
# FaxJobId : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t FaxSendDocumentW(
    void* FaxHandle,
    const uint16_t* FileName,
    void* JobParams,
    void* CoverpageInfo,
    uint32_t* FaxJobId);
]]
local winfax = ffi.load("winfax")
-- winfax.FaxSendDocumentW(FaxHandle, FileName, JobParams, CoverpageInfo, FaxJobId)
-- FaxHandle : HANDLE
-- FileName : LPCWSTR
-- JobParams : FAX_JOB_PARAMW*
-- CoverpageInfo : FAX_COVERPAGE_INFOW*
-- FaxJobId : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('WINFAX.dll');
const FaxSendDocumentW = lib.func('__stdcall', 'FaxSendDocumentW', 'int32_t', ['void *', 'str16', 'void *', 'void *', 'uint32_t *']);
// FaxSendDocumentW(FaxHandle, FileName, JobParams, CoverpageInfo, FaxJobId)
// FaxHandle : HANDLE -> 'void *'
// FileName : LPCWSTR -> 'str16'
// JobParams : FAX_JOB_PARAMW* -> 'void *'
// CoverpageInfo : FAX_COVERPAGE_INFOW* -> 'void *'
// FaxJobId : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINFAX.dll", {
  FaxSendDocumentW: { parameters: ["pointer", "buffer", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.FaxSendDocumentW(FaxHandle, FileName, JobParams, CoverpageInfo, FaxJobId)
// FaxHandle : HANDLE -> "pointer"
// FileName : LPCWSTR -> "buffer"
// JobParams : FAX_JOB_PARAMW* -> "pointer"
// CoverpageInfo : FAX_COVERPAGE_INFOW* -> "pointer"
// FaxJobId : DWORD* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t FaxSendDocumentW(
    void* FaxHandle,
    const uint16_t* FileName,
    void* JobParams,
    void* CoverpageInfo,
    uint32_t* FaxJobId);
C, "WINFAX.dll");
// $ffi->FaxSendDocumentW(FaxHandle, FileName, JobParams, CoverpageInfo, FaxJobId);
// FaxHandle : HANDLE
// FileName : LPCWSTR
// JobParams : FAX_JOB_PARAMW*
// CoverpageInfo : FAX_COVERPAGE_INFOW*
// FaxJobId : 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, W32APIOptions.UNICODE_OPTIONS);
    boolean FaxSendDocumentW(
        Pointer FaxHandle,   // HANDLE
        WString FileName,   // LPCWSTR
        Pointer JobParams,   // FAX_JOB_PARAMW*
        Pointer CoverpageInfo,   // FAX_COVERPAGE_INFOW*
        IntByReference FaxJobId   // DWORD* out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("winfax")]
lib LibWINFAX
  fun FaxSendDocumentW = FaxSendDocumentW(
    FaxHandle : Void*,   # HANDLE
    FileName : UInt16*,   # LPCWSTR
    JobParams : FAX_JOB_PARAMW*,   # FAX_JOB_PARAMW*
    CoverpageInfo : FAX_COVERPAGE_INFOW*,   # FAX_COVERPAGE_INFOW*
    FaxJobId : 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 FaxSendDocumentWNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
typedef FaxSendDocumentWDart = int Function(Pointer<Void>, Pointer<Utf16>, Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
final FaxSendDocumentW = DynamicLibrary.open('WINFAX.dll')
    .lookupFunction<FaxSendDocumentWNative, FaxSendDocumentWDart>('FaxSendDocumentW');
// FaxHandle : HANDLE -> Pointer<Void>
// FileName : LPCWSTR -> Pointer<Utf16>
// JobParams : FAX_JOB_PARAMW* -> Pointer<Void>
// CoverpageInfo : FAX_COVERPAGE_INFOW* -> Pointer<Void>
// FaxJobId : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
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';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FaxSendDocumentW"
  c_FaxSendDocumentW :: Ptr () -> CWString -> Ptr () -> Ptr () -> Ptr Word32 -> IO CInt
-- FaxHandle : HANDLE -> Ptr ()
-- FileName : LPCWSTR -> CWString
-- JobParams : FAX_JOB_PARAMW* -> Ptr ()
-- CoverpageInfo : FAX_COVERPAGE_INFOW* -> Ptr ()
-- FaxJobId : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let faxsenddocumentw =
  foreign "FaxSendDocumentW"
    ((ptr void) @-> (ptr uint16_t) @-> (ptr void) @-> (ptr void) @-> (ptr uint32_t) @-> returning int32_t)
(* FaxHandle : HANDLE -> (ptr void) *)
(* FileName : LPCWSTR -> (ptr uint16_t) *)
(* JobParams : FAX_JOB_PARAMW* -> (ptr void) *)
(* CoverpageInfo : FAX_COVERPAGE_INFOW* -> (ptr void) *)
(* FaxJobId : 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 ("FaxSendDocumentW" fax-send-document-w :convention :stdcall) :int32
  (fax-handle :pointer)   ; HANDLE
  (file-name (:string :encoding :utf-16le))   ; LPCWSTR
  (job-params :pointer)   ; FAX_JOB_PARAMW*
  (coverpage-info :pointer)   ; FAX_COVERPAGE_INFOW*
  (fax-job-id :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FaxSendDocumentW = Win32::API::More->new('WINFAX',
    'BOOL FaxSendDocumentW(HANDLE FaxHandle, LPCWSTR FileName, LPVOID JobParams, LPVOID CoverpageInfo, LPVOID FaxJobId)');
# my $ret = $FaxSendDocumentW->Call($FaxHandle, $FileName, $JobParams, $CoverpageInfo, $FaxJobId);
# FaxHandle : HANDLE -> HANDLE
# FileName : LPCWSTR -> LPCWSTR
# JobParams : FAX_JOB_PARAMW* -> LPVOID
# CoverpageInfo : FAX_COVERPAGE_INFOW* -> LPVOID
# FaxJobId : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型