FaxEnumPortsA

関数

ファクスサーバー上のすべてのファクスポートを列挙する。

DLLWINFAX.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL FaxEnumPortsA(
    HANDLE FaxHandle,
    FAX_PORT_INFOA** PortInfo,
    DWORD* PortsReturned
);

パラメーター

名前	型	方向	説明
FaxHandle	HANDLE	in	FAXサーバー接続のハンドルを指定する。
PortInfo	FAX_PORT_INFOA**	out	ポート情報配列(FAX_PORT_INFOA)を受け取るポインタ。FaxFreeBufferで解放する。
PortsReturned	DWORD*	out	返されたポート数を受け取るDWORDへのポインタを指定する。出力専用。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL FaxEnumPortsA(
    HANDLE FaxHandle,
    FAX_PORT_INFOA** PortInfo,
    DWORD* PortsReturned
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINFAX.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool FaxEnumPortsA(
    IntPtr FaxHandle,   // HANDLE
    IntPtr PortInfo,   // FAX_PORT_INFOA** out
    out uint PortsReturned   // DWORD* out
);

<DllImport("WINFAX.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FaxEnumPortsA(
    FaxHandle As IntPtr,   ' HANDLE
    PortInfo As IntPtr,   ' FAX_PORT_INFOA** out
    <Out> ByRef PortsReturned As UInteger   ' DWORD* out
) As Boolean
End Function

' FaxHandle : HANDLE
' PortInfo : FAX_PORT_INFOA** out
' PortsReturned : DWORD* out
Declare PtrSafe Function FaxEnumPortsA Lib "winfax" ( _
    ByVal FaxHandle As LongPtr, _
    ByVal PortInfo As LongPtr, _
    ByRef PortsReturned As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

FaxEnumPortsA = ctypes.windll.winfax.FaxEnumPortsA
FaxEnumPortsA.restype = wintypes.BOOL
FaxEnumPortsA.argtypes = [
    wintypes.HANDLE,  # FaxHandle : HANDLE
    ctypes.c_void_p,  # PortInfo : FAX_PORT_INFOA** out
    ctypes.POINTER(wintypes.DWORD),  # PortsReturned : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINFAX.dll')
FaxEnumPortsA = Fiddle::Function.new(
  lib['FaxEnumPortsA'],
  [
    Fiddle::TYPE_VOIDP,  # FaxHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # PortInfo : FAX_PORT_INFOA** out
    Fiddle::TYPE_VOIDP,  # PortsReturned : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "winfax")]
extern "system" {
    fn FaxEnumPortsA(
        FaxHandle: *mut core::ffi::c_void,  // HANDLE
        PortInfo: *mut *mut FAX_PORT_INFOA,  // FAX_PORT_INFOA** out
        PortsReturned: *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 FaxEnumPortsA(IntPtr FaxHandle, IntPtr PortInfo, out uint PortsReturned);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINFAX_FaxEnumPortsA' -Namespace Win32 -PassThru
# $api::FaxEnumPortsA(FaxHandle, PortInfo, PortsReturned)

#uselib "WINFAX.dll"
#func global FaxEnumPortsA "FaxEnumPortsA" sptr, sptr, sptr
; FaxEnumPortsA FaxHandle, varptr(PortInfo), varptr(PortsReturned)   ; 戻り値は stat
; FaxHandle : HANDLE -> "sptr"
; PortInfo : FAX_PORT_INFOA** out -> "sptr"
; PortsReturned : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WINFAX.dll"
#cfunc global FaxEnumPortsA "FaxEnumPortsA" sptr, var, var
; res = FaxEnumPortsA(FaxHandle, PortInfo, PortsReturned)
; FaxHandle : HANDLE -> "sptr"
; PortInfo : FAX_PORT_INFOA** out -> "var"
; PortsReturned : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WINFAX.dll"
#cfunc global FaxEnumPortsA "FaxEnumPortsA" sptr, sptr, sptr
; res = FaxEnumPortsA(FaxHandle, varptr(PortInfo), varptr(PortsReturned))
; FaxHandle : HANDLE -> "sptr"
; PortInfo : FAX_PORT_INFOA** out -> "sptr"
; PortsReturned : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; BOOL FaxEnumPortsA(HANDLE FaxHandle, FAX_PORT_INFOA** PortInfo, DWORD* PortsReturned)
#uselib "WINFAX.dll"
#cfunc global FaxEnumPortsA "FaxEnumPortsA" intptr, var, var
; res = FaxEnumPortsA(FaxHandle, PortInfo, PortsReturned)
; FaxHandle : HANDLE -> "intptr"
; PortInfo : FAX_PORT_INFOA** out -> "var"
; PortsReturned : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL FaxEnumPortsA(HANDLE FaxHandle, FAX_PORT_INFOA** PortInfo, DWORD* PortsReturned)
#uselib "WINFAX.dll"
#cfunc global FaxEnumPortsA "FaxEnumPortsA" intptr, intptr, intptr
; res = FaxEnumPortsA(FaxHandle, varptr(PortInfo), varptr(PortsReturned))
; FaxHandle : HANDLE -> "intptr"
; PortInfo : FAX_PORT_INFOA** out -> "intptr"
; PortsReturned : DWORD* out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winfax = windows.NewLazySystemDLL("WINFAX.dll")
	procFaxEnumPortsA = winfax.NewProc("FaxEnumPortsA")
)

// FaxHandle (HANDLE), PortInfo (FAX_PORT_INFOA** out), PortsReturned (DWORD* out)
r1, _, err := procFaxEnumPortsA.Call(
	uintptr(FaxHandle),
	uintptr(PortInfo),
	uintptr(PortsReturned),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function FaxEnumPortsA(
  FaxHandle: THandle;   // HANDLE
  PortInfo: Pointer;   // FAX_PORT_INFOA** out
  PortsReturned: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'WINFAX.dll' name 'FaxEnumPortsA';

result := DllCall("WINFAX\FaxEnumPortsA"
    , "Ptr", FaxHandle   ; HANDLE
    , "Ptr", PortInfo   ; FAX_PORT_INFOA** out
    , "Ptr", PortsReturned   ; DWORD* out
    , "Int")   ; return: BOOL

●FaxEnumPortsA(FaxHandle, PortInfo, PortsReturned) = DLL("WINFAX.dll", "bool FaxEnumPortsA(void*, void*, void*)")
# 呼び出し: FaxEnumPortsA(FaxHandle, PortInfo, PortsReturned)
# FaxHandle : HANDLE -> "void*"
# PortInfo : FAX_PORT_INFOA** out -> "void*"
# PortsReturned : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。