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

FaxStartPrintJobA

関数
ファクスプリンターへの印刷ジョブを開始しデバイスコンテキストを取得する。
DLLWINFAX.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL FaxStartPrintJobA(
    LPCSTR PrinterName,
    const FAX_PRINT_INFOA* PrintInfo,
    DWORD* FaxJobId,
    FAX_CONTEXT_INFOA* FaxContextInfo
);

パラメーター

名前方向説明
PrinterNameLPCSTRin印刷に用いるFAXプリンタ名(ANSI)を指定する。送信用の仮想プリンタを指す。
PrintInfoFAX_PRINT_INFOA*in送信先や送信者などの印刷情報(FAX_PRINT_INFOA)へのポインタを指定する。
FaxJobIdDWORD*out作成された印刷ジョブのIDを受け取るDWORDへのポインタを指定する。出力専用。
FaxContextInfoFAX_CONTEXT_INFOA*out印刷コンテキスト情報(FAX_CONTEXT_INFOA)を受け取る構造体へのポインタを指定する。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

FaxStartPrintJobA = ctypes.windll.winfax.FaxStartPrintJobA
FaxStartPrintJobA.restype = wintypes.BOOL
FaxStartPrintJobA.argtypes = [
    wintypes.LPCSTR,  # PrinterName : LPCSTR
    ctypes.c_void_p,  # PrintInfo : FAX_PRINT_INFOA*
    ctypes.POINTER(wintypes.DWORD),  # FaxJobId : DWORD* out
    ctypes.c_void_p,  # FaxContextInfo : FAX_CONTEXT_INFOA* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	winfax = windows.NewLazySystemDLL("WINFAX.dll")
	procFaxStartPrintJobA = winfax.NewProc("FaxStartPrintJobA")
)

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

extern "winfax" fn FaxStartPrintJobA(
    PrinterName: [*c]const u8, // LPCSTR
    PrintInfo: [*c]FAX_PRINT_INFOA, // FAX_PRINT_INFOA*
    FaxJobId: [*c]u32, // DWORD* out
    FaxContextInfo: [*c]FAX_CONTEXT_INFOA // FAX_CONTEXT_INFOA* out
) callconv(std.os.windows.WINAPI) i32;
proc FaxStartPrintJobA(
    PrinterName: cstring,  # LPCSTR
    PrintInfo: ptr FAX_PRINT_INFOA,  # FAX_PRINT_INFOA*
    FaxJobId: ptr uint32,  # DWORD* out
    FaxContextInfo: ptr FAX_CONTEXT_INFOA  # FAX_CONTEXT_INFOA* out
): int32 {.importc: "FaxStartPrintJobA", stdcall, dynlib: "WINFAX.dll".}
pragma(lib, "winfax");
extern(Windows)
int FaxStartPrintJobA(
    const(char)* PrinterName,   // LPCSTR
    FAX_PRINT_INFOA* PrintInfo,   // FAX_PRINT_INFOA*
    uint* FaxJobId,   // DWORD* out
    FAX_CONTEXT_INFOA* FaxContextInfo   // FAX_CONTEXT_INFOA* out
);
ccall((:FaxStartPrintJobA, "WINFAX.dll"), stdcall, Int32,
      (Cstring, Ptr{FAX_PRINT_INFOA}, Ptr{UInt32}, Ptr{FAX_CONTEXT_INFOA}),
      PrinterName, PrintInfo, FaxJobId, FaxContextInfo)
# PrinterName : LPCSTR -> Cstring
# PrintInfo : FAX_PRINT_INFOA* -> Ptr{FAX_PRINT_INFOA}
# FaxJobId : DWORD* out -> Ptr{UInt32}
# FaxContextInfo : FAX_CONTEXT_INFOA* out -> Ptr{FAX_CONTEXT_INFOA}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t FaxStartPrintJobA(
    const char* PrinterName,
    void* PrintInfo,
    uint32_t* FaxJobId,
    void* FaxContextInfo);
]]
local winfax = ffi.load("winfax")
-- winfax.FaxStartPrintJobA(PrinterName, PrintInfo, FaxJobId, FaxContextInfo)
-- PrinterName : LPCSTR
-- PrintInfo : FAX_PRINT_INFOA*
-- FaxJobId : DWORD* out
-- FaxContextInfo : FAX_CONTEXT_INFOA* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINFAX.dll');
const FaxStartPrintJobA = lib.func('__stdcall', 'FaxStartPrintJobA', 'int32_t', ['str', 'void *', 'uint32_t *', 'void *']);
// FaxStartPrintJobA(PrinterName, PrintInfo, FaxJobId, FaxContextInfo)
// PrinterName : LPCSTR -> 'str'
// PrintInfo : FAX_PRINT_INFOA* -> 'void *'
// FaxJobId : DWORD* out -> 'uint32_t *'
// FaxContextInfo : FAX_CONTEXT_INFOA* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINFAX.dll", {
  FaxStartPrintJobA: { parameters: ["buffer", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.FaxStartPrintJobA(PrinterName, PrintInfo, FaxJobId, FaxContextInfo)
// PrinterName : LPCSTR -> "buffer"
// PrintInfo : FAX_PRINT_INFOA* -> "pointer"
// FaxJobId : DWORD* out -> "pointer"
// FaxContextInfo : FAX_CONTEXT_INFOA* out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t FaxStartPrintJobA(
    const char* PrinterName,
    void* PrintInfo,
    uint32_t* FaxJobId,
    void* FaxContextInfo);
C, "WINFAX.dll");
// $ffi->FaxStartPrintJobA(PrinterName, PrintInfo, FaxJobId, FaxContextInfo);
// PrinterName : LPCSTR
// PrintInfo : FAX_PRINT_INFOA*
// FaxJobId : DWORD* out
// FaxContextInfo : FAX_CONTEXT_INFOA* 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 FaxStartPrintJobA(
        String PrinterName,   // LPCSTR
        Pointer PrintInfo,   // FAX_PRINT_INFOA*
        IntByReference FaxJobId,   // DWORD* out
        Pointer FaxContextInfo   // FAX_CONTEXT_INFOA* out
    );
}
@[Link("winfax")]
lib LibWINFAX
  fun FaxStartPrintJobA = FaxStartPrintJobA(
    PrinterName : UInt8*,   # LPCSTR
    PrintInfo : FAX_PRINT_INFOA*,   # FAX_PRINT_INFOA*
    FaxJobId : UInt32*,   # DWORD* out
    FaxContextInfo : FAX_CONTEXT_INFOA*   # FAX_CONTEXT_INFOA* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef FaxStartPrintJobANative = Int32 Function(Pointer<Utf8>, Pointer<Void>, Pointer<Uint32>, Pointer<Void>);
typedef FaxStartPrintJobADart = int Function(Pointer<Utf8>, Pointer<Void>, Pointer<Uint32>, Pointer<Void>);
final FaxStartPrintJobA = DynamicLibrary.open('WINFAX.dll')
    .lookupFunction<FaxStartPrintJobANative, FaxStartPrintJobADart>('FaxStartPrintJobA');
// PrinterName : LPCSTR -> Pointer<Utf8>
// PrintInfo : FAX_PRINT_INFOA* -> Pointer<Void>
// FaxJobId : DWORD* out -> Pointer<Uint32>
// FaxContextInfo : FAX_CONTEXT_INFOA* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FaxStartPrintJobA(
  PrinterName: PAnsiChar;   // LPCSTR
  PrintInfo: Pointer;   // FAX_PRINT_INFOA*
  FaxJobId: Pointer;   // DWORD* out
  FaxContextInfo: Pointer   // FAX_CONTEXT_INFOA* out
): BOOL; stdcall;
  external 'WINFAX.dll' name 'FaxStartPrintJobA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FaxStartPrintJobA"
  c_FaxStartPrintJobA :: CString -> Ptr () -> Ptr Word32 -> Ptr () -> IO CInt
-- PrinterName : LPCSTR -> CString
-- PrintInfo : FAX_PRINT_INFOA* -> Ptr ()
-- FaxJobId : DWORD* out -> Ptr Word32
-- FaxContextInfo : FAX_CONTEXT_INFOA* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let faxstartprintjoba =
  foreign "FaxStartPrintJobA"
    (string @-> (ptr void) @-> (ptr uint32_t) @-> (ptr void) @-> returning int32_t)
(* PrinterName : LPCSTR -> string *)
(* PrintInfo : FAX_PRINT_INFOA* -> (ptr void) *)
(* FaxJobId : DWORD* out -> (ptr uint32_t) *)
(* FaxContextInfo : FAX_CONTEXT_INFOA* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winfax (t "WINFAX.dll"))
(cffi:use-foreign-library winfax)

(cffi:defcfun ("FaxStartPrintJobA" fax-start-print-job-a :convention :stdcall) :int32
  (printer-name :string)   ; LPCSTR
  (print-info :pointer)   ; FAX_PRINT_INFOA*
  (fax-job-id :pointer)   ; DWORD* out
  (fax-context-info :pointer))   ; FAX_CONTEXT_INFOA* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FaxStartPrintJobA = Win32::API::More->new('WINFAX',
    'BOOL FaxStartPrintJobA(LPCSTR PrinterName, LPVOID PrintInfo, LPVOID FaxJobId, LPVOID FaxContextInfo)');
# my $ret = $FaxStartPrintJobA->Call($PrinterName, $PrintInfo, $FaxJobId, $FaxContextInfo);
# PrinterName : LPCSTR -> LPCSTR
# PrintInfo : FAX_PRINT_INFOA* -> LPVOID
# FaxJobId : DWORD* out -> LPVOID
# FaxContextInfo : FAX_CONTEXT_INFOA* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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