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
);

パラメーター

名前方向説明
FaxHandleHANDLEinFAXサーバー接続のハンドルを指定する。
JobEntryFAX_JOB_ENTRYA**outジョブ情報配列(FAX_JOB_ENTRYA)を受け取るポインタを指定する。FaxFreeBufferで解放する。
JobsReturnedDWORD*out返されたジョブ数を受け取るDWORDへのポインタを指定する。出力専用。

戻り値の型: 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 <MarshalAs(UnmanagedType.Bool)> 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)。
const std = @import("std");

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

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

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

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

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

関連項目

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