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

FaxEnumJobsA

関数
ファクスキュー内のすべてのジョブ情報を列挙する。
DLLWINFAX.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL FaxEnumJobsA(
    HANDLE FaxHandle,
    FAX_JOB_ENTRYA** JobEntry,
    DWORD* JobsReturned
);

パラメーター

名前方向
FaxHandleHANDLEin
JobEntryFAX_JOB_ENTRYA**out
JobsReturnedDWORD*out

戻り値の型: BOOL

各言語での呼び出し定義

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

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

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

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

var (
	winfax = windows.NewLazySystemDLL("WINFAX.dll")
	procFaxEnumJobsA = winfax.NewProc("FaxEnumJobsA")
)

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