ホーム › Devices.Fax › FaxEnumPortsW
FaxEnumPortsW
関数ファクスサーバー上のすべてのファクスポートを列挙する。
シグネチャ
// WINFAX.dll (Unicode / -W)
#include <windows.h>
BOOL FaxEnumPortsW(
HANDLE FaxHandle,
FAX_PORT_INFOW** PortInfo,
DWORD* PortsReturned
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| FaxHandle | HANDLE | in | FAXサーバー接続のハンドルを指定する。 |
| PortInfo | FAX_PORT_INFOW** | out | ポート情報配列(FAX_PORT_INFOW)を受け取るポインタ。FaxFreeBufferで解放する。 |
| PortsReturned | DWORD* | out | 返されたポート数を受け取るDWORDへのポインタを指定する。出力専用。 |
戻り値の型: BOOL
各言語での呼び出し定義
// WINFAX.dll (Unicode / -W)
#include <windows.h>
BOOL FaxEnumPortsW(
HANDLE FaxHandle,
FAX_PORT_INFOW** PortInfo,
DWORD* PortsReturned
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINFAX.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool FaxEnumPortsW(
IntPtr FaxHandle, // HANDLE
IntPtr PortInfo, // FAX_PORT_INFOW** out
out uint PortsReturned // DWORD* out
);<DllImport("WINFAX.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FaxEnumPortsW(
FaxHandle As IntPtr, ' HANDLE
PortInfo As IntPtr, ' FAX_PORT_INFOW** out
<Out> ByRef PortsReturned As UInteger ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' FaxHandle : HANDLE
' PortInfo : FAX_PORT_INFOW** out
' PortsReturned : DWORD* out
Declare PtrSafe Function FaxEnumPortsW Lib "winfax" ( _
ByVal FaxHandle As LongPtr, _
ByVal PortInfo As LongPtr, _
ByRef PortsReturned As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
FaxEnumPortsW = ctypes.windll.winfax.FaxEnumPortsW
FaxEnumPortsW.restype = wintypes.BOOL
FaxEnumPortsW.argtypes = [
wintypes.HANDLE, # FaxHandle : HANDLE
ctypes.c_void_p, # PortInfo : FAX_PORT_INFOW** 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')
FaxEnumPortsW = Fiddle::Function.new(
lib['FaxEnumPortsW'],
[
Fiddle::TYPE_VOIDP, # FaxHandle : HANDLE
Fiddle::TYPE_VOIDP, # PortInfo : FAX_PORT_INFOW** out
Fiddle::TYPE_VOIDP, # PortsReturned : DWORD* out
],
Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "winfax")]
extern "system" {
fn FaxEnumPortsW(
FaxHandle: *mut core::ffi::c_void, // HANDLE
PortInfo: *mut *mut FAX_PORT_INFOW, // FAX_PORT_INFOW** 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.Unicode, SetLastError = true)]
public static extern bool FaxEnumPortsW(IntPtr FaxHandle, IntPtr PortInfo, out uint PortsReturned);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINFAX_FaxEnumPortsW' -Namespace Win32 -PassThru
# $api::FaxEnumPortsW(FaxHandle, PortInfo, PortsReturned)#uselib "WINFAX.dll"
#func global FaxEnumPortsW "FaxEnumPortsW" wptr, wptr, wptr
; FaxEnumPortsW FaxHandle, varptr(PortInfo), varptr(PortsReturned) ; 戻り値は stat
; FaxHandle : HANDLE -> "wptr"
; PortInfo : FAX_PORT_INFOW** out -> "wptr"
; PortsReturned : DWORD* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "WINFAX.dll" #cfunc global FaxEnumPortsW "FaxEnumPortsW" sptr, var, var ; res = FaxEnumPortsW(FaxHandle, PortInfo, PortsReturned) ; FaxHandle : HANDLE -> "sptr" ; PortInfo : FAX_PORT_INFOW** out -> "var" ; PortsReturned : DWORD* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WINFAX.dll" #cfunc global FaxEnumPortsW "FaxEnumPortsW" sptr, sptr, sptr ; res = FaxEnumPortsW(FaxHandle, varptr(PortInfo), varptr(PortsReturned)) ; FaxHandle : HANDLE -> "sptr" ; PortInfo : FAX_PORT_INFOW** out -> "sptr" ; PortsReturned : DWORD* out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; BOOL FaxEnumPortsW(HANDLE FaxHandle, FAX_PORT_INFOW** PortInfo, DWORD* PortsReturned) #uselib "WINFAX.dll" #cfunc global FaxEnumPortsW "FaxEnumPortsW" intptr, var, var ; res = FaxEnumPortsW(FaxHandle, PortInfo, PortsReturned) ; FaxHandle : HANDLE -> "intptr" ; PortInfo : FAX_PORT_INFOW** out -> "var" ; PortsReturned : DWORD* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL FaxEnumPortsW(HANDLE FaxHandle, FAX_PORT_INFOW** PortInfo, DWORD* PortsReturned) #uselib "WINFAX.dll" #cfunc global FaxEnumPortsW "FaxEnumPortsW" intptr, intptr, intptr ; res = FaxEnumPortsW(FaxHandle, varptr(PortInfo), varptr(PortsReturned)) ; FaxHandle : HANDLE -> "intptr" ; PortInfo : FAX_PORT_INFOW** out -> "intptr" ; PortsReturned : DWORD* out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
winfax = windows.NewLazySystemDLL("WINFAX.dll")
procFaxEnumPortsW = winfax.NewProc("FaxEnumPortsW")
)
// FaxHandle (HANDLE), PortInfo (FAX_PORT_INFOW** out), PortsReturned (DWORD* out)
r1, _, err := procFaxEnumPortsW.Call(
uintptr(FaxHandle),
uintptr(PortInfo),
uintptr(PortsReturned),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction FaxEnumPortsW(
FaxHandle: THandle; // HANDLE
PortInfo: Pointer; // FAX_PORT_INFOW** out
PortsReturned: Pointer // DWORD* out
): BOOL; stdcall;
external 'WINFAX.dll' name 'FaxEnumPortsW';result := DllCall("WINFAX\FaxEnumPortsW"
, "Ptr", FaxHandle ; HANDLE
, "Ptr", PortInfo ; FAX_PORT_INFOW** out
, "Ptr", PortsReturned ; DWORD* out
, "Int") ; return: BOOL●FaxEnumPortsW(FaxHandle, PortInfo, PortsReturned) = DLL("WINFAX.dll", "bool FaxEnumPortsW(void*, void*, void*)")
# 呼び出し: FaxEnumPortsW(FaxHandle, PortInfo, PortsReturned)
# FaxHandle : HANDLE -> "void*"
# PortInfo : FAX_PORT_INFOW** out -> "void*"
# PortsReturned : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "winfax" fn FaxEnumPortsW(
FaxHandle: ?*anyopaque, // HANDLE
PortInfo: [*c][*c]FAX_PORT_INFOW, // FAX_PORT_INFOW** out
PortsReturned: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc FaxEnumPortsW(
FaxHandle: pointer, # HANDLE
PortInfo: ptr FAX_PORT_INFOW, # FAX_PORT_INFOW** out
PortsReturned: ptr uint32 # DWORD* out
): int32 {.importc: "FaxEnumPortsW", stdcall, dynlib: "WINFAX.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "winfax");
extern(Windows)
int FaxEnumPortsW(
void* FaxHandle, // HANDLE
FAX_PORT_INFOW** PortInfo, // FAX_PORT_INFOW** out
uint* PortsReturned // DWORD* out
);ccall((:FaxEnumPortsW, "WINFAX.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{FAX_PORT_INFOW}, Ptr{UInt32}),
FaxHandle, PortInfo, PortsReturned)
# FaxHandle : HANDLE -> Ptr{Cvoid}
# PortInfo : FAX_PORT_INFOW** out -> Ptr{FAX_PORT_INFOW}
# PortsReturned : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t FaxEnumPortsW(
void* FaxHandle,
void* PortInfo,
uint32_t* PortsReturned);
]]
local winfax = ffi.load("winfax")
-- winfax.FaxEnumPortsW(FaxHandle, PortInfo, PortsReturned)
-- FaxHandle : HANDLE
-- PortInfo : FAX_PORT_INFOW** out
-- PortsReturned : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。const koffi = require('koffi');
const lib = koffi.load('WINFAX.dll');
const FaxEnumPortsW = lib.func('__stdcall', 'FaxEnumPortsW', 'int32_t', ['void *', 'void *', 'uint32_t *']);
// FaxEnumPortsW(FaxHandle, PortInfo, PortsReturned)
// FaxHandle : HANDLE -> 'void *'
// PortInfo : FAX_PORT_INFOW** out -> 'void *'
// PortsReturned : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("WINFAX.dll", {
FaxEnumPortsW: { parameters: ["pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.FaxEnumPortsW(FaxHandle, PortInfo, PortsReturned)
// FaxHandle : HANDLE -> "pointer"
// PortInfo : FAX_PORT_INFOW** out -> "pointer"
// PortsReturned : DWORD* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t FaxEnumPortsW(
void* FaxHandle,
void* PortInfo,
uint32_t* PortsReturned);
C, "WINFAX.dll");
// $ffi->FaxEnumPortsW(FaxHandle, PortInfo, PortsReturned);
// FaxHandle : HANDLE
// PortInfo : FAX_PORT_INFOW** 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.UNICODE_OPTIONS);
boolean FaxEnumPortsW(
Pointer FaxHandle, // HANDLE
Pointer PortInfo, // FAX_PORT_INFOW** out
IntByReference PortsReturned // DWORD* out
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("winfax")]
lib LibWINFAX
fun FaxEnumPortsW = FaxEnumPortsW(
FaxHandle : Void*, # HANDLE
PortInfo : FAX_PORT_INFOW**, # FAX_PORT_INFOW** 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 FaxEnumPortsWNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
typedef FaxEnumPortsWDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
final FaxEnumPortsW = DynamicLibrary.open('WINFAX.dll')
.lookupFunction<FaxEnumPortsWNative, FaxEnumPortsWDart>('FaxEnumPortsW');
// FaxHandle : HANDLE -> Pointer<Void>
// PortInfo : FAX_PORT_INFOW** out -> Pointer<Void>
// PortsReturned : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function FaxEnumPortsW(
FaxHandle: THandle; // HANDLE
PortInfo: Pointer; // FAX_PORT_INFOW** out
PortsReturned: Pointer // DWORD* out
): BOOL; stdcall;
external 'WINFAX.dll' name 'FaxEnumPortsW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "FaxEnumPortsW"
c_FaxEnumPortsW :: Ptr () -> Ptr () -> Ptr Word32 -> IO CInt
-- FaxHandle : HANDLE -> Ptr ()
-- PortInfo : FAX_PORT_INFOW** out -> Ptr ()
-- PortsReturned : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let faxenumportsw =
foreign "FaxEnumPortsW"
((ptr void) @-> (ptr void) @-> (ptr uint32_t) @-> returning int32_t)
(* FaxHandle : HANDLE -> (ptr void) *)
(* PortInfo : FAX_PORT_INFOW** 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 ("FaxEnumPortsW" fax-enum-ports-w :convention :stdcall) :int32
(fax-handle :pointer) ; HANDLE
(port-info :pointer) ; FAX_PORT_INFOW** out
(ports-returned :pointer)) ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $FaxEnumPortsW = Win32::API::More->new('WINFAX',
'BOOL FaxEnumPortsW(HANDLE FaxHandle, LPVOID PortInfo, LPVOID PortsReturned)');
# my $ret = $FaxEnumPortsW->Call($FaxHandle, $PortInfo, $PortsReturned);
# FaxHandle : HANDLE -> HANDLE
# PortInfo : FAX_PORT_INFOW** out -> LPVOID
# PortsReturned : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
文字セット違い
- f FaxEnumPortsA (ANSI版) — ファクスサーバー上のすべてのファクスポートを列挙する。
使用する型