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

FaxPrintCoverPageA

関数
指定したデバイスコンテキストにファクスのカバーページを描画する。
DLLWINFAX.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL FaxPrintCoverPageA(
    const FAX_CONTEXT_INFOA* FaxContextInfo,
    const FAX_COVERPAGE_INFOA* CoverPageInfo
);

パラメーター

名前方向説明
FaxContextInfoFAX_CONTEXT_INFOA*inFaxStartPrintJobで得た印刷コンテキスト情報(FAX_CONTEXT_INFOA)へのポインタを指定する。
CoverPageInfoFAX_COVERPAGE_INFOA*in印刷するカバーページ情報(FAX_COVERPAGE_INFOA)へのポインタを指定する。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL FaxPrintCoverPageA(
    const FAX_CONTEXT_INFOA* FaxContextInfo,
    const FAX_COVERPAGE_INFOA* CoverPageInfo
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINFAX.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool FaxPrintCoverPageA(
    IntPtr FaxContextInfo,   // FAX_CONTEXT_INFOA*
    IntPtr CoverPageInfo   // FAX_COVERPAGE_INFOA*
);
<DllImport("WINFAX.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FaxPrintCoverPageA(
    FaxContextInfo As IntPtr,   ' FAX_CONTEXT_INFOA*
    CoverPageInfo As IntPtr   ' FAX_COVERPAGE_INFOA*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' FaxContextInfo : FAX_CONTEXT_INFOA*
' CoverPageInfo : FAX_COVERPAGE_INFOA*
Declare PtrSafe Function FaxPrintCoverPageA Lib "winfax" ( _
    ByVal FaxContextInfo As LongPtr, _
    ByVal CoverPageInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FaxPrintCoverPageA = ctypes.windll.winfax.FaxPrintCoverPageA
FaxPrintCoverPageA.restype = wintypes.BOOL
FaxPrintCoverPageA.argtypes = [
    ctypes.c_void_p,  # FaxContextInfo : FAX_CONTEXT_INFOA*
    ctypes.c_void_p,  # CoverPageInfo : FAX_COVERPAGE_INFOA*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	winfax = windows.NewLazySystemDLL("WINFAX.dll")
	procFaxPrintCoverPageA = winfax.NewProc("FaxPrintCoverPageA")
)

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

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

typedef FaxPrintCoverPageANative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef FaxPrintCoverPageADart = int Function(Pointer<Void>, Pointer<Void>);
final FaxPrintCoverPageA = DynamicLibrary.open('WINFAX.dll')
    .lookupFunction<FaxPrintCoverPageANative, FaxPrintCoverPageADart>('FaxPrintCoverPageA');
// FaxContextInfo : FAX_CONTEXT_INFOA* -> Pointer<Void>
// CoverPageInfo : FAX_COVERPAGE_INFOA* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FaxPrintCoverPageA(
  FaxContextInfo: Pointer;   // FAX_CONTEXT_INFOA*
  CoverPageInfo: Pointer   // FAX_COVERPAGE_INFOA*
): BOOL; stdcall;
  external 'WINFAX.dll' name 'FaxPrintCoverPageA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FaxPrintCoverPageA"
  c_FaxPrintCoverPageA :: Ptr () -> Ptr () -> IO CInt
-- FaxContextInfo : FAX_CONTEXT_INFOA* -> Ptr ()
-- CoverPageInfo : FAX_COVERPAGE_INFOA* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let faxprintcoverpagea =
  foreign "FaxPrintCoverPageA"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* FaxContextInfo : FAX_CONTEXT_INFOA* -> (ptr void) *)
(* CoverPageInfo : FAX_COVERPAGE_INFOA* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winfax (t "WINFAX.dll"))
(cffi:use-foreign-library winfax)

(cffi:defcfun ("FaxPrintCoverPageA" fax-print-cover-page-a :convention :stdcall) :int32
  (fax-context-info :pointer)   ; FAX_CONTEXT_INFOA*
  (cover-page-info :pointer))   ; FAX_COVERPAGE_INFOA*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FaxPrintCoverPageA = Win32::API::More->new('WINFAX',
    'BOOL FaxPrintCoverPageA(LPVOID FaxContextInfo, LPVOID CoverPageInfo)');
# my $ret = $FaxPrintCoverPageA->Call($FaxContextInfo, $CoverPageInfo);
# FaxContextInfo : FAX_CONTEXT_INFOA* -> LPVOID
# CoverPageInfo : FAX_COVERPAGE_INFOA* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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