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

FaxPrintCoverPageW

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

シグネチャ

// WINFAX.dll  (Unicode / -W)
#include <windows.h>

BOOL FaxPrintCoverPageW(
    const FAX_CONTEXT_INFOW* FaxContextInfo,
    const FAX_COVERPAGE_INFOW* CoverPageInfo
);

パラメーター

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

戻り値の型: BOOL

各言語での呼び出し定義

// WINFAX.dll  (Unicode / -W)
#include <windows.h>

BOOL FaxPrintCoverPageW(
    const FAX_CONTEXT_INFOW* FaxContextInfo,
    const FAX_COVERPAGE_INFOW* CoverPageInfo
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINFAX.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool FaxPrintCoverPageW(
    IntPtr FaxContextInfo,   // FAX_CONTEXT_INFOW*
    IntPtr CoverPageInfo   // FAX_COVERPAGE_INFOW*
);
<DllImport("WINFAX.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FaxPrintCoverPageW(
    FaxContextInfo As IntPtr,   ' FAX_CONTEXT_INFOW*
    CoverPageInfo As IntPtr   ' FAX_COVERPAGE_INFOW*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' FaxContextInfo : FAX_CONTEXT_INFOW*
' CoverPageInfo : FAX_COVERPAGE_INFOW*
Declare PtrSafe Function FaxPrintCoverPageW Lib "winfax" ( _
    ByVal FaxContextInfo As LongPtr, _
    ByVal CoverPageInfo As LongPtr) 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

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

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

var (
	winfax = windows.NewLazySystemDLL("WINFAX.dll")
	procFaxPrintCoverPageW = winfax.NewProc("FaxPrintCoverPageW")
)

// FaxContextInfo (FAX_CONTEXT_INFOW*), CoverPageInfo (FAX_COVERPAGE_INFOW*)
r1, _, err := procFaxPrintCoverPageW.Call(
	uintptr(FaxContextInfo),
	uintptr(CoverPageInfo),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function FaxPrintCoverPageW(
  FaxContextInfo: Pointer;   // FAX_CONTEXT_INFOW*
  CoverPageInfo: Pointer   // FAX_COVERPAGE_INFOW*
): BOOL; stdcall;
  external 'WINFAX.dll' name 'FaxPrintCoverPageW';
result := DllCall("WINFAX\FaxPrintCoverPageW"
    , "Ptr", FaxContextInfo   ; FAX_CONTEXT_INFOW*
    , "Ptr", CoverPageInfo   ; FAX_COVERPAGE_INFOW*
    , "Int")   ; return: BOOL
●FaxPrintCoverPageW(FaxContextInfo, CoverPageInfo) = DLL("WINFAX.dll", "bool FaxPrintCoverPageW(void*, void*)")
# 呼び出し: FaxPrintCoverPageW(FaxContextInfo, CoverPageInfo)
# FaxContextInfo : FAX_CONTEXT_INFOW* -> "void*"
# CoverPageInfo : FAX_COVERPAGE_INFOW* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "winfax" fn FaxPrintCoverPageW(
    FaxContextInfo: [*c]FAX_CONTEXT_INFOW, // FAX_CONTEXT_INFOW*
    CoverPageInfo: [*c]FAX_COVERPAGE_INFOW // FAX_COVERPAGE_INFOW*
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc FaxPrintCoverPageW(
    FaxContextInfo: ptr FAX_CONTEXT_INFOW,  # FAX_CONTEXT_INFOW*
    CoverPageInfo: ptr FAX_COVERPAGE_INFOW  # FAX_COVERPAGE_INFOW*
): int32 {.importc: "FaxPrintCoverPageW", stdcall, dynlib: "WINFAX.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "winfax");
extern(Windows)
int FaxPrintCoverPageW(
    FAX_CONTEXT_INFOW* FaxContextInfo,   // FAX_CONTEXT_INFOW*
    FAX_COVERPAGE_INFOW* CoverPageInfo   // FAX_COVERPAGE_INFOW*
);
ccall((:FaxPrintCoverPageW, "WINFAX.dll"), stdcall, Int32,
      (Ptr{FAX_CONTEXT_INFOW}, Ptr{FAX_COVERPAGE_INFOW}),
      FaxContextInfo, CoverPageInfo)
# FaxContextInfo : FAX_CONTEXT_INFOW* -> Ptr{FAX_CONTEXT_INFOW}
# CoverPageInfo : FAX_COVERPAGE_INFOW* -> Ptr{FAX_COVERPAGE_INFOW}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t FaxPrintCoverPageW(
    void* FaxContextInfo,
    void* CoverPageInfo);
]]
local winfax = ffi.load("winfax")
-- winfax.FaxPrintCoverPageW(FaxContextInfo, CoverPageInfo)
-- FaxContextInfo : FAX_CONTEXT_INFOW*
-- CoverPageInfo : FAX_COVERPAGE_INFOW*
-- 構造体/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 FaxPrintCoverPageW = lib.func('__stdcall', 'FaxPrintCoverPageW', 'int32_t', ['void *', 'void *']);
// FaxPrintCoverPageW(FaxContextInfo, CoverPageInfo)
// FaxContextInfo : FAX_CONTEXT_INFOW* -> 'void *'
// CoverPageInfo : FAX_COVERPAGE_INFOW* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINFAX.dll", {
  FaxPrintCoverPageW: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.FaxPrintCoverPageW(FaxContextInfo, CoverPageInfo)
// FaxContextInfo : FAX_CONTEXT_INFOW* -> "pointer"
// CoverPageInfo : FAX_COVERPAGE_INFOW* -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t FaxPrintCoverPageW(
    void* FaxContextInfo,
    void* CoverPageInfo);
C, "WINFAX.dll");
// $ffi->FaxPrintCoverPageW(FaxContextInfo, CoverPageInfo);
// FaxContextInfo : FAX_CONTEXT_INFOW*
// CoverPageInfo : FAX_COVERPAGE_INFOW*
// 構造体/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 FaxPrintCoverPageW(
        Pointer FaxContextInfo,   // FAX_CONTEXT_INFOW*
        Pointer CoverPageInfo   // FAX_COVERPAGE_INFOW*
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("winfax")]
lib LibWINFAX
  fun FaxPrintCoverPageW = FaxPrintCoverPageW(
    FaxContextInfo : FAX_CONTEXT_INFOW*,   # FAX_CONTEXT_INFOW*
    CoverPageInfo : FAX_COVERPAGE_INFOW*   # FAX_COVERPAGE_INFOW*
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

(cffi:defcfun ("FaxPrintCoverPageW" fax-print-cover-page-w :convention :stdcall) :int32
  (fax-context-info :pointer)   ; FAX_CONTEXT_INFOW*
  (cover-page-info :pointer))   ; FAX_COVERPAGE_INFOW*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FaxPrintCoverPageW = Win32::API::More->new('WINFAX',
    'BOOL FaxPrintCoverPageW(LPVOID FaxContextInfo, LPVOID CoverPageInfo)');
# my $ret = $FaxPrintCoverPageW->Call($FaxContextInfo, $CoverPageInfo);
# FaxContextInfo : FAX_CONTEXT_INFOW* -> LPVOID
# CoverPageInfo : FAX_COVERPAGE_INFOW* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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