ホーム › Devices.Fax › FaxSendDocumentA
FaxSendDocumentA
関数FAXで文書を送信する(ANSI版)。
シグネチャ
// 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 | FAXサーバー接続のハンドルを指定する。 |
| FileName | LPCSTR | in | 送信する文書ファイルのパス(ANSI)を指定する。TIFF等の送信可能形式を指す。 |
| JobParams | FAX_JOB_PARAMA* | in | 送信ジョブのパラメータを格納したFAX_JOB_PARAMA構造体へのポインタを指定する。 |
| CoverpageInfo | FAX_COVERPAGE_INFOA* | in | カバーページ情報のFAX_COVERPAGE_INFOA構造体へのポインタを指定する。NULL可。 |
| FaxJobId | DWORD* | out | 作成された送信ジョブのIDを受け取るDWORDへのポインタを指定する。出力専用。 |
戻り値の型: 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 <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(変数))。
出力引数:
; 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 方式にも切替可。; 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, intptr, intptr, intptr ; res = FaxSendDocumentA(FaxHandle, FileName, varptr(JobParams), varptr(CoverpageInfo), varptr(FaxJobId)) ; FaxHandle : HANDLE -> "intptr" ; FileName : LPCSTR -> "str" ; JobParams : FAX_JOB_PARAMA* -> "intptr" ; CoverpageInfo : FAX_COVERPAGE_INFOA* -> "intptr" ; FaxJobId : DWORD* out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは 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 // BOOLfunction 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)。const std = @import("std");
extern "winfax" fn FaxSendDocumentA(
FaxHandle: ?*anyopaque, // HANDLE
FileName: [*c]const u8, // LPCSTR
JobParams: [*c]FAX_JOB_PARAMA, // FAX_JOB_PARAMA*
CoverpageInfo: [*c]FAX_COVERPAGE_INFOA, // FAX_COVERPAGE_INFOA*
FaxJobId: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;proc FaxSendDocumentA(
FaxHandle: pointer, # HANDLE
FileName: cstring, # LPCSTR
JobParams: ptr FAX_JOB_PARAMA, # FAX_JOB_PARAMA*
CoverpageInfo: ptr FAX_COVERPAGE_INFOA, # FAX_COVERPAGE_INFOA*
FaxJobId: ptr uint32 # DWORD* out
): int32 {.importc: "FaxSendDocumentA", stdcall, dynlib: "WINFAX.dll".}pragma(lib, "winfax");
extern(Windows)
int FaxSendDocumentA(
void* FaxHandle, // HANDLE
const(char)* FileName, // LPCSTR
FAX_JOB_PARAMA* JobParams, // FAX_JOB_PARAMA*
FAX_COVERPAGE_INFOA* CoverpageInfo, // FAX_COVERPAGE_INFOA*
uint* FaxJobId // DWORD* out
);ccall((:FaxSendDocumentA, "WINFAX.dll"), stdcall, Int32,
(Ptr{Cvoid}, Cstring, Ptr{FAX_JOB_PARAMA}, Ptr{FAX_COVERPAGE_INFOA}, Ptr{UInt32}),
FaxHandle, FileName, JobParams, CoverpageInfo, FaxJobId)
# FaxHandle : HANDLE -> Ptr{Cvoid}
# FileName : LPCSTR -> Cstring
# JobParams : FAX_JOB_PARAMA* -> Ptr{FAX_JOB_PARAMA}
# CoverpageInfo : FAX_COVERPAGE_INFOA* -> Ptr{FAX_COVERPAGE_INFOA}
# FaxJobId : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t FaxSendDocumentA(
void* FaxHandle,
const char* FileName,
void* JobParams,
void* CoverpageInfo,
uint32_t* FaxJobId);
]]
local winfax = ffi.load("winfax")
-- winfax.FaxSendDocumentA(FaxHandle, FileName, JobParams, CoverpageInfo, FaxJobId)
-- FaxHandle : HANDLE
-- FileName : LPCSTR
-- JobParams : FAX_JOB_PARAMA*
-- CoverpageInfo : FAX_COVERPAGE_INFOA*
-- FaxJobId : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('WINFAX.dll');
const FaxSendDocumentA = lib.func('__stdcall', 'FaxSendDocumentA', 'int32_t', ['void *', 'str', 'void *', 'void *', 'uint32_t *']);
// FaxSendDocumentA(FaxHandle, FileName, JobParams, CoverpageInfo, FaxJobId)
// FaxHandle : HANDLE -> 'void *'
// FileName : LPCSTR -> 'str'
// JobParams : FAX_JOB_PARAMA* -> 'void *'
// CoverpageInfo : FAX_COVERPAGE_INFOA* -> 'void *'
// FaxJobId : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("WINFAX.dll", {
FaxSendDocumentA: { parameters: ["pointer", "buffer", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.FaxSendDocumentA(FaxHandle, FileName, JobParams, CoverpageInfo, FaxJobId)
// FaxHandle : HANDLE -> "pointer"
// FileName : LPCSTR -> "buffer"
// JobParams : FAX_JOB_PARAMA* -> "pointer"
// CoverpageInfo : FAX_COVERPAGE_INFOA* -> "pointer"
// FaxJobId : DWORD* out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t FaxSendDocumentA(
void* FaxHandle,
const char* FileName,
void* JobParams,
void* CoverpageInfo,
uint32_t* FaxJobId);
C, "WINFAX.dll");
// $ffi->FaxSendDocumentA(FaxHandle, FileName, JobParams, CoverpageInfo, FaxJobId);
// FaxHandle : HANDLE
// FileName : LPCSTR
// JobParams : FAX_JOB_PARAMA*
// CoverpageInfo : FAX_COVERPAGE_INFOA*
// 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.ASCII_OPTIONS);
boolean FaxSendDocumentA(
Pointer FaxHandle, // HANDLE
String FileName, // LPCSTR
Pointer JobParams, // FAX_JOB_PARAMA*
Pointer CoverpageInfo, // FAX_COVERPAGE_INFOA*
IntByReference FaxJobId // DWORD* out
);
}@[Link("winfax")]
lib LibWINFAX
fun FaxSendDocumentA = FaxSendDocumentA(
FaxHandle : Void*, # HANDLE
FileName : UInt8*, # LPCSTR
JobParams : FAX_JOB_PARAMA*, # FAX_JOB_PARAMA*
CoverpageInfo : FAX_COVERPAGE_INFOA*, # FAX_COVERPAGE_INFOA*
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 FaxSendDocumentANative = Int32 Function(Pointer<Void>, Pointer<Utf8>, Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
typedef FaxSendDocumentADart = int Function(Pointer<Void>, Pointer<Utf8>, Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
final FaxSendDocumentA = DynamicLibrary.open('WINFAX.dll')
.lookupFunction<FaxSendDocumentANative, FaxSendDocumentADart>('FaxSendDocumentA');
// FaxHandle : HANDLE -> Pointer<Void>
// FileName : LPCSTR -> Pointer<Utf8>
// JobParams : FAX_JOB_PARAMA* -> Pointer<Void>
// CoverpageInfo : FAX_COVERPAGE_INFOA* -> Pointer<Void>
// FaxJobId : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
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';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "FaxSendDocumentA"
c_FaxSendDocumentA :: Ptr () -> CString -> Ptr () -> Ptr () -> Ptr Word32 -> IO CInt
-- FaxHandle : HANDLE -> Ptr ()
-- FileName : LPCSTR -> CString
-- JobParams : FAX_JOB_PARAMA* -> Ptr ()
-- CoverpageInfo : FAX_COVERPAGE_INFOA* -> Ptr ()
-- FaxJobId : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let faxsenddocumenta =
foreign "FaxSendDocumentA"
((ptr void) @-> string @-> (ptr void) @-> (ptr void) @-> (ptr uint32_t) @-> returning int32_t)
(* FaxHandle : HANDLE -> (ptr void) *)
(* FileName : LPCSTR -> string *)
(* JobParams : FAX_JOB_PARAMA* -> (ptr void) *)
(* CoverpageInfo : FAX_COVERPAGE_INFOA* -> (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 ("FaxSendDocumentA" fax-send-document-a :convention :stdcall) :int32
(fax-handle :pointer) ; HANDLE
(file-name :string) ; LPCSTR
(job-params :pointer) ; FAX_JOB_PARAMA*
(coverpage-info :pointer) ; FAX_COVERPAGE_INFOA*
(fax-job-id :pointer)) ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $FaxSendDocumentA = Win32::API::More->new('WINFAX',
'BOOL FaxSendDocumentA(HANDLE FaxHandle, LPCSTR FileName, LPVOID JobParams, LPVOID CoverpageInfo, LPVOID FaxJobId)');
# my $ret = $FaxSendDocumentA->Call($FaxHandle, $FileName, $JobParams, $CoverpageInfo, $FaxJobId);
# FaxHandle : HANDLE -> HANDLE
# FileName : LPCSTR -> LPCSTR
# JobParams : FAX_JOB_PARAMA* -> LPVOID
# CoverpageInfo : FAX_COVERPAGE_INFOA* -> LPVOID
# FaxJobId : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f FaxSendDocumentW (Unicode版) — 指定したファイルをファクス文書として送信ジョブに登録する。