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

FaxSetJobA

関数
指定したファクスジョブに一時停止や再開などのコマンドを適用する。
DLLWINFAX.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL FaxSetJobA(
    HANDLE FaxHandle,
    DWORD JobId,
    DWORD Command,
    const FAX_JOB_ENTRYA* JobEntry
);

パラメーター

名前方向説明
FaxHandleHANDLEinFAXサーバー接続のハンドルを指定する。
JobIdDWORDin操作対象のFAXジョブIDを指定する。
CommandDWORDinジョブに対する操作を指定するコマンド。JC_DELETE/JC_PAUSE/JC_RESUME等を指定する。
JobEntryFAX_JOB_ENTRYA*in更新するジョブ情報(FAX_JOB_ENTRYA)へのポインタを指定する。NULL可。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

FaxSetJobA = ctypes.windll.winfax.FaxSetJobA
FaxSetJobA.restype = wintypes.BOOL
FaxSetJobA.argtypes = [
    wintypes.HANDLE,  # FaxHandle : HANDLE
    wintypes.DWORD,  # JobId : DWORD
    wintypes.DWORD,  # Command : DWORD
    ctypes.c_void_p,  # JobEntry : FAX_JOB_ENTRYA*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	winfax = windows.NewLazySystemDLL("WINFAX.dll")
	procFaxSetJobA = winfax.NewProc("FaxSetJobA")
)

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

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

typedef FaxSetJobANative = Int32 Function(Pointer<Void>, Uint32, Uint32, Pointer<Void>);
typedef FaxSetJobADart = int Function(Pointer<Void>, int, int, Pointer<Void>);
final FaxSetJobA = DynamicLibrary.open('WINFAX.dll')
    .lookupFunction<FaxSetJobANative, FaxSetJobADart>('FaxSetJobA');
// FaxHandle : HANDLE -> Pointer<Void>
// JobId : DWORD -> Uint32
// Command : DWORD -> Uint32
// JobEntry : FAX_JOB_ENTRYA* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FaxSetJobA(
  FaxHandle: THandle;   // HANDLE
  JobId: DWORD;   // DWORD
  Command: DWORD;   // DWORD
  JobEntry: Pointer   // FAX_JOB_ENTRYA*
): BOOL; stdcall;
  external 'WINFAX.dll' name 'FaxSetJobA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FaxSetJobA"
  c_FaxSetJobA :: Ptr () -> Word32 -> Word32 -> Ptr () -> IO CInt
-- FaxHandle : HANDLE -> Ptr ()
-- JobId : DWORD -> Word32
-- Command : DWORD -> Word32
-- JobEntry : FAX_JOB_ENTRYA* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let faxsetjoba =
  foreign "FaxSetJobA"
    ((ptr void) @-> uint32_t @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* FaxHandle : HANDLE -> (ptr void) *)
(* JobId : DWORD -> uint32_t *)
(* Command : DWORD -> uint32_t *)
(* JobEntry : FAX_JOB_ENTRYA* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winfax (t "WINFAX.dll"))
(cffi:use-foreign-library winfax)

(cffi:defcfun ("FaxSetJobA" fax-set-job-a :convention :stdcall) :int32
  (fax-handle :pointer)   ; HANDLE
  (job-id :uint32)   ; DWORD
  (command :uint32)   ; DWORD
  (job-entry :pointer))   ; FAX_JOB_ENTRYA*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FaxSetJobA = Win32::API::More->new('WINFAX',
    'BOOL FaxSetJobA(HANDLE FaxHandle, DWORD JobId, DWORD Command, LPVOID JobEntry)');
# my $ret = $FaxSetJobA->Call($FaxHandle, $JobId, $Command, $JobEntry);
# FaxHandle : HANDLE -> HANDLE
# JobId : DWORD -> DWORD
# Command : DWORD -> DWORD
# JobEntry : FAX_JOB_ENTRYA* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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