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

FaxGetJobA

関数
指定したジョブIDのファクスジョブ情報を取得する。
DLLWINFAX.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL FaxGetJobA(
    HANDLE FaxHandle,
    DWORD JobId,
    FAX_JOB_ENTRYA** JobEntry
);

パラメーター

名前方向説明
FaxHandleHANDLEinFAXサーバー接続のハンドルを指定する。
JobIdDWORDin情報を取得する対象のFAXジョブIDを指定する。
JobEntryFAX_JOB_ENTRYA**outジョブ情報(FAX_JOB_ENTRYA)を受け取るポインタを指定する。FaxFreeBufferで解放する。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL FaxGetJobA(
    HANDLE FaxHandle,
    DWORD JobId,
    FAX_JOB_ENTRYA** JobEntry
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINFAX.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool FaxGetJobA(
    IntPtr FaxHandle,   // HANDLE
    uint JobId,   // DWORD
    IntPtr JobEntry   // FAX_JOB_ENTRYA** out
);
<DllImport("WINFAX.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FaxGetJobA(
    FaxHandle As IntPtr,   ' HANDLE
    JobId As UInteger,   ' DWORD
    JobEntry As IntPtr   ' FAX_JOB_ENTRYA** out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' FaxHandle : HANDLE
' JobId : DWORD
' JobEntry : FAX_JOB_ENTRYA** out
Declare PtrSafe Function FaxGetJobA Lib "winfax" ( _
    ByVal FaxHandle As LongPtr, _
    ByVal JobId 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

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

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

var (
	winfax = windows.NewLazySystemDLL("WINFAX.dll")
	procFaxGetJobA = winfax.NewProc("FaxGetJobA")
)

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

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

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

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

let faxgetjoba =
  foreign "FaxGetJobA"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* FaxHandle : HANDLE -> (ptr void) *)
(* JobId : DWORD -> uint32_t *)
(* JobEntry : FAX_JOB_ENTRYA** 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 ("FaxGetJobA" fax-get-job-a :convention :stdcall) :int32
  (fax-handle :pointer)   ; HANDLE
  (job-id :uint32)   ; DWORD
  (job-entry :pointer))   ; FAX_JOB_ENTRYA** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FaxGetJobA = Win32::API::More->new('WINFAX',
    'BOOL FaxGetJobA(HANDLE FaxHandle, DWORD JobId, LPVOID JobEntry)');
# my $ret = $FaxGetJobA->Call($FaxHandle, $JobId, $JobEntry);
# FaxHandle : HANDLE -> HANDLE
# JobId : DWORD -> DWORD
# JobEntry : FAX_JOB_ENTRYA** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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