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

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

パラメーター

名前方向説明
FaxHandleHANDLEinFAXサーバー接続のハンドルを指定する。
PortInfoFAX_PORT_INFOA**outポート情報配列(FAX_PORT_INFOA)を受け取るポインタ。FaxFreeBufferで解放する。
PortsReturnedDWORD*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 <MarshalAs(UnmanagedType.Bool)> 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 方式にも切替可。
出力引数:
; 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 方式にも切替可。
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)。
const std = @import("std");

extern "winfax" fn FaxEnumPortsA(
    FaxHandle: ?*anyopaque, // HANDLE
    PortInfo: [*c][*c]FAX_PORT_INFOA, // FAX_PORT_INFOA** out
    PortsReturned: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;
proc FaxEnumPortsA(
    FaxHandle: pointer,  # HANDLE
    PortInfo: ptr FAX_PORT_INFOA,  # FAX_PORT_INFOA** out
    PortsReturned: ptr uint32  # DWORD* out
): int32 {.importc: "FaxEnumPortsA", stdcall, dynlib: "WINFAX.dll".}
pragma(lib, "winfax");
extern(Windows)
int FaxEnumPortsA(
    void* FaxHandle,   // HANDLE
    FAX_PORT_INFOA** PortInfo,   // FAX_PORT_INFOA** out
    uint* PortsReturned   // DWORD* out
);
ccall((:FaxEnumPortsA, "WINFAX.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{FAX_PORT_INFOA}, Ptr{UInt32}),
      FaxHandle, PortInfo, PortsReturned)
# FaxHandle : HANDLE -> Ptr{Cvoid}
# PortInfo : FAX_PORT_INFOA** out -> Ptr{FAX_PORT_INFOA}
# PortsReturned : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t FaxEnumPortsA(
    void* FaxHandle,
    void* PortInfo,
    uint32_t* PortsReturned);
]]
local winfax = ffi.load("winfax")
-- winfax.FaxEnumPortsA(FaxHandle, PortInfo, PortsReturned)
-- FaxHandle : HANDLE
-- PortInfo : FAX_PORT_INFOA** out
-- PortsReturned : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINFAX.dll');
const FaxEnumPortsA = lib.func('__stdcall', 'FaxEnumPortsA', 'int32_t', ['void *', 'void *', 'uint32_t *']);
// FaxEnumPortsA(FaxHandle, PortInfo, PortsReturned)
// FaxHandle : HANDLE -> 'void *'
// PortInfo : FAX_PORT_INFOA** out -> 'void *'
// PortsReturned : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINFAX.dll", {
  FaxEnumPortsA: { parameters: ["pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.FaxEnumPortsA(FaxHandle, PortInfo, PortsReturned)
// FaxHandle : HANDLE -> "pointer"
// PortInfo : FAX_PORT_INFOA** out -> "pointer"
// PortsReturned : DWORD* out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t FaxEnumPortsA(
    void* FaxHandle,
    void* PortInfo,
    uint32_t* PortsReturned);
C, "WINFAX.dll");
// $ffi->FaxEnumPortsA(FaxHandle, PortInfo, PortsReturned);
// FaxHandle : HANDLE
// PortInfo : FAX_PORT_INFOA** out
// PortsReturned : 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 FaxEnumPortsA(
        Pointer FaxHandle,   // HANDLE
        Pointer PortInfo,   // FAX_PORT_INFOA** out
        IntByReference PortsReturned   // DWORD* out
    );
}
@[Link("winfax")]
lib LibWINFAX
  fun FaxEnumPortsA = FaxEnumPortsA(
    FaxHandle : Void*,   # HANDLE
    PortInfo : FAX_PORT_INFOA**,   # FAX_PORT_INFOA** out
    PortsReturned : 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 FaxEnumPortsANative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
typedef FaxEnumPortsADart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
final FaxEnumPortsA = DynamicLibrary.open('WINFAX.dll')
    .lookupFunction<FaxEnumPortsANative, FaxEnumPortsADart>('FaxEnumPortsA');
// FaxHandle : HANDLE -> Pointer<Void>
// PortInfo : FAX_PORT_INFOA** out -> Pointer<Void>
// PortsReturned : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FaxEnumPortsA(
  FaxHandle: THandle;   // HANDLE
  PortInfo: Pointer;   // FAX_PORT_INFOA** out
  PortsReturned: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'WINFAX.dll' name 'FaxEnumPortsA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

関連項目

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