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

FaxCompleteJobParamsA

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

シグネチャ

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

BOOL FaxCompleteJobParamsA(
    FAX_JOB_PARAMA** JobParams,
    FAX_COVERPAGE_INFOA** CoverpageInfo
);

パラメーター

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

戻り値の型: BOOL

各言語での呼び出し定義

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

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

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

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

var (
	winfax = windows.NewLazySystemDLL("WINFAX.dll")
	procFaxCompleteJobParamsA = winfax.NewProc("FaxCompleteJobParamsA")
)

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

extern "winfax" fn FaxCompleteJobParamsA(
    JobParams: [*c][*c]FAX_JOB_PARAMA, // FAX_JOB_PARAMA** in/out
    CoverpageInfo: [*c][*c]FAX_COVERPAGE_INFOA // FAX_COVERPAGE_INFOA** in/out
) callconv(std.os.windows.WINAPI) i32;
proc FaxCompleteJobParamsA(
    JobParams: ptr FAX_JOB_PARAMA,  # FAX_JOB_PARAMA** in/out
    CoverpageInfo: ptr FAX_COVERPAGE_INFOA  # FAX_COVERPAGE_INFOA** in/out
): int32 {.importc: "FaxCompleteJobParamsA", stdcall, dynlib: "WINFAX.dll".}
pragma(lib, "winfax");
extern(Windows)
int FaxCompleteJobParamsA(
    FAX_JOB_PARAMA** JobParams,   // FAX_JOB_PARAMA** in/out
    FAX_COVERPAGE_INFOA** CoverpageInfo   // FAX_COVERPAGE_INFOA** in/out
);
ccall((:FaxCompleteJobParamsA, "WINFAX.dll"), stdcall, Int32,
      (Ptr{FAX_JOB_PARAMA}, Ptr{FAX_COVERPAGE_INFOA}),
      JobParams, CoverpageInfo)
# JobParams : FAX_JOB_PARAMA** in/out -> Ptr{FAX_JOB_PARAMA}
# CoverpageInfo : FAX_COVERPAGE_INFOA** in/out -> Ptr{FAX_COVERPAGE_INFOA}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t FaxCompleteJobParamsA(
    void* JobParams,
    void* CoverpageInfo);
]]
local winfax = ffi.load("winfax")
-- winfax.FaxCompleteJobParamsA(JobParams, CoverpageInfo)
-- JobParams : FAX_JOB_PARAMA** in/out
-- CoverpageInfo : FAX_COVERPAGE_INFOA** in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINFAX.dll');
const FaxCompleteJobParamsA = lib.func('__stdcall', 'FaxCompleteJobParamsA', 'int32_t', ['void *', 'void *']);
// FaxCompleteJobParamsA(JobParams, CoverpageInfo)
// JobParams : FAX_JOB_PARAMA** in/out -> 'void *'
// CoverpageInfo : FAX_COVERPAGE_INFOA** in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINFAX.dll", {
  FaxCompleteJobParamsA: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.FaxCompleteJobParamsA(JobParams, CoverpageInfo)
// JobParams : FAX_JOB_PARAMA** in/out -> "pointer"
// CoverpageInfo : FAX_COVERPAGE_INFOA** in/out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t FaxCompleteJobParamsA(
    void* JobParams,
    void* CoverpageInfo);
C, "WINFAX.dll");
// $ffi->FaxCompleteJobParamsA(JobParams, CoverpageInfo);
// JobParams : FAX_JOB_PARAMA** in/out
// CoverpageInfo : FAX_COVERPAGE_INFOA** 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.ASCII_OPTIONS);
    boolean FaxCompleteJobParamsA(
        Pointer JobParams,   // FAX_JOB_PARAMA** in/out
        Pointer CoverpageInfo   // FAX_COVERPAGE_INFOA** in/out
    );
}
@[Link("winfax")]
lib LibWINFAX
  fun FaxCompleteJobParamsA = FaxCompleteJobParamsA(
    JobParams : FAX_JOB_PARAMA**,   # FAX_JOB_PARAMA** in/out
    CoverpageInfo : FAX_COVERPAGE_INFOA**   # FAX_COVERPAGE_INFOA** 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 FaxCompleteJobParamsANative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef FaxCompleteJobParamsADart = int Function(Pointer<Void>, Pointer<Void>);
final FaxCompleteJobParamsA = DynamicLibrary.open('WINFAX.dll')
    .lookupFunction<FaxCompleteJobParamsANative, FaxCompleteJobParamsADart>('FaxCompleteJobParamsA');
// JobParams : FAX_JOB_PARAMA** in/out -> Pointer<Void>
// CoverpageInfo : FAX_COVERPAGE_INFOA** in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FaxCompleteJobParamsA(
  JobParams: Pointer;   // FAX_JOB_PARAMA** in/out
  CoverpageInfo: Pointer   // FAX_COVERPAGE_INFOA** in/out
): BOOL; stdcall;
  external 'WINFAX.dll' name 'FaxCompleteJobParamsA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let faxcompletejobparamsa =
  foreign "FaxCompleteJobParamsA"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* JobParams : FAX_JOB_PARAMA** in/out -> (ptr void) *)
(* CoverpageInfo : FAX_COVERPAGE_INFOA** 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 ("FaxCompleteJobParamsA" fax-complete-job-params-a :convention :stdcall) :int32
  (job-params :pointer)   ; FAX_JOB_PARAMA** in/out
  (coverpage-info :pointer))   ; FAX_COVERPAGE_INFOA** in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FaxCompleteJobParamsA = Win32::API::More->new('WINFAX',
    'BOOL FaxCompleteJobParamsA(LPVOID JobParams, LPVOID CoverpageInfo)');
# my $ret = $FaxCompleteJobParamsA->Call($JobParams, $CoverpageInfo);
# JobParams : FAX_JOB_PARAMA** in/out -> LPVOID
# CoverpageInfo : FAX_COVERPAGE_INFOA** in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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