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

FaxCompleteJobParamsW

関数
FAXジョブパラメータと送付状情報を初期化する(Unicode版)。
DLLWINFAX.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL FaxCompleteJobParamsW(
    FAX_JOB_PARAMW** JobParams,
    FAX_COVERPAGE_INFOW** CoverpageInfo
);

パラメーター

名前方向説明
JobParamsFAX_JOB_PARAMW**inoutFAX_JOB_PARAMW構造体ポインタを受け取るポインタ。送信者情報等を補完して返す。
CoverpageInfoFAX_COVERPAGE_INFOW**inoutFAX_COVERPAGE_INFOW構造体ポインタを受け取るポインタ。カバーページ情報を補完して返す。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL FaxCompleteJobParamsW(
    FAX_JOB_PARAMW** JobParams,
    FAX_COVERPAGE_INFOW** CoverpageInfo
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINFAX.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool FaxCompleteJobParamsW(
    IntPtr JobParams,   // FAX_JOB_PARAMW** in/out
    IntPtr CoverpageInfo   // FAX_COVERPAGE_INFOW** in/out
);
<DllImport("WINFAX.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function FaxCompleteJobParamsW(
    JobParams As IntPtr,   ' FAX_JOB_PARAMW** in/out
    CoverpageInfo As IntPtr   ' FAX_COVERPAGE_INFOW** in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' JobParams : FAX_JOB_PARAMW** in/out
' CoverpageInfo : FAX_COVERPAGE_INFOW** in/out
Declare PtrSafe Function FaxCompleteJobParamsW Lib "winfax" ( _
    ByVal JobParams 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

FaxCompleteJobParamsW = ctypes.windll.winfax.FaxCompleteJobParamsW
FaxCompleteJobParamsW.restype = wintypes.BOOL
FaxCompleteJobParamsW.argtypes = [
    ctypes.c_void_p,  # JobParams : FAX_JOB_PARAMW** in/out
    ctypes.c_void_p,  # CoverpageInfo : FAX_COVERPAGE_INFOW** in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINFAX.dll')
FaxCompleteJobParamsW = Fiddle::Function.new(
  lib['FaxCompleteJobParamsW'],
  [
    Fiddle::TYPE_VOIDP,  # JobParams : FAX_JOB_PARAMW** in/out
    Fiddle::TYPE_VOIDP,  # CoverpageInfo : FAX_COVERPAGE_INFOW** in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "winfax")]
extern "system" {
    fn FaxCompleteJobParamsW(
        JobParams: *mut *mut FAX_JOB_PARAMW,  // FAX_JOB_PARAMW** in/out
        CoverpageInfo: *mut *mut FAX_COVERPAGE_INFOW  // FAX_COVERPAGE_INFOW** in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINFAX.dll", CharSet = CharSet.Unicode)]
public static extern bool FaxCompleteJobParamsW(IntPtr JobParams, IntPtr CoverpageInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINFAX_FaxCompleteJobParamsW' -Namespace Win32 -PassThru
# $api::FaxCompleteJobParamsW(JobParams, CoverpageInfo)
#uselib "WINFAX.dll"
#func global FaxCompleteJobParamsW "FaxCompleteJobParamsW" wptr, wptr
; FaxCompleteJobParamsW varptr(JobParams), varptr(CoverpageInfo)   ; 戻り値は stat
; JobParams : FAX_JOB_PARAMW** in/out -> "wptr"
; CoverpageInfo : FAX_COVERPAGE_INFOW** in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WINFAX.dll"
#cfunc global FaxCompleteJobParamsW "FaxCompleteJobParamsW" var, var
; res = FaxCompleteJobParamsW(JobParams, CoverpageInfo)
; JobParams : FAX_JOB_PARAMW** in/out -> "var"
; CoverpageInfo : FAX_COVERPAGE_INFOW** in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL FaxCompleteJobParamsW(FAX_JOB_PARAMW** JobParams, FAX_COVERPAGE_INFOW** CoverpageInfo)
#uselib "WINFAX.dll"
#cfunc global FaxCompleteJobParamsW "FaxCompleteJobParamsW" var, var
; res = FaxCompleteJobParamsW(JobParams, CoverpageInfo)
; JobParams : FAX_JOB_PARAMW** in/out -> "var"
; CoverpageInfo : FAX_COVERPAGE_INFOW** in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winfax = windows.NewLazySystemDLL("WINFAX.dll")
	procFaxCompleteJobParamsW = winfax.NewProc("FaxCompleteJobParamsW")
)

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

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

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

foreign import stdcall safe "FaxCompleteJobParamsW"
  c_FaxCompleteJobParamsW :: Ptr () -> Ptr () -> IO CInt
-- JobParams : FAX_JOB_PARAMW** in/out -> Ptr ()
-- CoverpageInfo : FAX_COVERPAGE_INFOW** in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let faxcompletejobparamsw =
  foreign "FaxCompleteJobParamsW"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* JobParams : FAX_JOB_PARAMW** in/out -> (ptr void) *)
(* CoverpageInfo : FAX_COVERPAGE_INFOW** in/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 ("FaxCompleteJobParamsW" fax-complete-job-params-w :convention :stdcall) :int32
  (job-params :pointer)   ; FAX_JOB_PARAMW** in/out
  (coverpage-info :pointer))   ; FAX_COVERPAGE_INFOW** in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FaxCompleteJobParamsW = Win32::API::More->new('WINFAX',
    'BOOL FaxCompleteJobParamsW(LPVOID JobParams, LPVOID CoverpageInfo)');
# my $ret = $FaxCompleteJobParamsW->Call($JobParams, $CoverpageInfo);
# JobParams : FAX_JOB_PARAMW** in/out -> LPVOID
# CoverpageInfo : FAX_COVERPAGE_INFOW** in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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