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

パラメーター

名前	型	方向	説明
FaxHandle	HANDLE	in	FaxConnectFaxServer 関数の呼び出しによって返された FAX サーバーのハンドルを指定します。
FileName	LPCSTR	in	転送する FAX ドキュメントを含むファイルの完全修飾パスと名前が格納された、定数の null 終端文字列へのポインターです。パスには UNC パス、またはドライブ文字で始まるパスを指定できます。このパラメーターには、有効なローカルファイル名を指定できます。ファイルは適切に登録されたファイル種類である必要があり、FAX サーバーがそのファイルにアクセスできる必要があります。
JobParams	FAX_JOB_PARAMA*	in	FAX サーバーが FAX を送信するために必要な情報を格納した FAX_JOB_PARAM 構造体へのポインターです。この構造体には、受信者の FAX 番号、送信者と受信者のデータ、省略可能な課金コード、ジョブのスケジュール情報などが含まれます。
CoverpageInfo	FAX_COVERPAGE_INFOA*	in	FAX ドキュメントの表紙に表示する個人データを格納した FAX_COVERPAGE_INFO 構造体へのポインターです。表紙が不要な場合、このパラメーターは NULL でなければなりません。
FaxJobId	DWORD*	out	FAX を送信するキューに登録されたジョブを識別する一意の番号を受け取る DWORD 変数へのポインターです。

戻り値の型: BOOL

公式ドキュメント

FAX クライアントアプリケーションは、送信する FAX を転送する FAX ジョブをキューに登録するために FaxSendDocument 関数を呼び出します。(ANSI)

戻り値

型: BOOL

関数が成功すると、戻り値は 0 以外の値になります。

関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を呼び出します。GetLastError は次のいずれかのエラーを返すことがあります。

戻り値	説明
ERROR_INVALID_PARAMETER	FaxHandle、JobParams、FileName パラメーターのいずれか、またはすべてが NULL です。FAX_JOB_PARAM 構造体の CallHandle メンバーで指定された呼び出しハンドルが無効です (NULL である必要があります)。または、FAX_JOB_PARAM 構造体の RecipientNumber メンバーが NULL です。
ERROR_INVALID_FUNCTION	FaxHandle パラメーターがリモート接続を指定していますが、FAX_JOB_PARAM 構造体の CallHandle メンバーが NULL ではありません。
ERROR_ACCESS_DENIED	アクセスが拒否されました。FAX_JOB_SUBMIT アクセス権が必要です。
ERROR_FILE_NOT_FOUND	FAX サーバーが、FileName パラメーターまたは CoverpageInfo パラメーターで指定されたファイルを見つけられません。
ERROR_INVALID_DATA	FAX サーバーが、FileName パラメーターまたは CoverpageInfo パラメーターで指定されたファイルを処理できません。
ERROR_NOT_SUPPORTED	FAX_JOB_PARAM 構造体の CallHandle メンバーを使用して、音声通話を FAX 送信に引き渡そうとしました。この機能はサポートされていません。

解説(Remarks)

FaxSendDocument 関数を呼び出す前に、FaxCompleteJobParams 関数を呼び出してください。FaxCompleteJobParams は、FAX_COVERPAGE_INFO 構造体とFAX_JOB_PARAM 構造体の複数のメンバーに、送信者名、FAX 番号、省略可能な課金コード情報などの情報を設定するユーティリティ関数です。

FaxSendDocument 関数は非同期に実行され、すぐに制御を返します。FAX サーバーは、FAX_JOB_PARAM 構造体で指定された内容に従って、FAX を送信するジョブをキューに登録します。

FaxSendDocument が成功するには、FAX サーバーにリモート FAX プリンターがインストールされている必要があります。

FAX ドキュメントを複数の受信者に効率よく送信するには、アプリケーションは FaxSendDocument 関数を複数回呼び出す必要があります。FaxSendDocumentForBroadcast 関数は、下位互換性のためにサポートされています。

アプリケーションからドキュメントを送信する際、ドキュメント内のリンクによって情報の入力を求めるダイアログが表示されることがあります。この情報要求に数分以内に応答しない場合、FaxSendDocument は失敗し、エラーを返します。

メモ

winfax.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして FaxSendDocument を定義しています。エンコード中立のエイリアスを、エンコード中立でないコードと混在させて使用すると、不一致が生じてコンパイルエラーや実行時エラーの原因となる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// 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 <MarshalAs(UnmanagedType.Bool)> 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 方式にも切替可。#uselib "WINFAX.dll"
#cfunc global FaxSendDocumentA "FaxSendDocumentA" sptr, str, sptr, sptr, sptr
; res = FaxSendDocumentA(FaxHandle, FileName, varptr(JobParams), varptr(CoverpageInfo), varptr(FaxJobId))
; FaxHandle : HANDLE -> "sptr"
; FileName : LPCSTR -> "str"
; JobParams : FAX_JOB_PARAMA* -> "sptr"
; CoverpageInfo : FAX_COVERPAGE_INFOA* -> "sptr"
; FaxJobId : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。