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

FaxEnumRoutingMethodsW

関数
指定したポートで利用可能なルーティング方法を列挙する。
DLLWINFAX.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// WINFAX.dll  (Unicode / -W)
#include <windows.h>

BOOL FaxEnumRoutingMethodsW(
    HANDLE FaxPortHandle,
    FAX_ROUTING_METHODW** RoutingMethod,
    DWORD* MethodsReturned
);

パラメーター

名前方向説明
FaxPortHandleHANDLEin対象のFAXポートハンドルを指定する。
RoutingMethodFAX_ROUTING_METHODW**outルーティングメソッド情報配列(FAX_ROUTING_METHODW)を受け取るポインタ。FaxFreeBufferで解放する。
MethodsReturnedDWORD*out返されたルーティングメソッド数を受け取るDWORDへのポインタを指定する。出力専用。

戻り値の型: BOOL

各言語での呼び出し定義

// WINFAX.dll  (Unicode / -W)
#include <windows.h>

BOOL FaxEnumRoutingMethodsW(
    HANDLE FaxPortHandle,
    FAX_ROUTING_METHODW** RoutingMethod,
    DWORD* MethodsReturned
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINFAX.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool FaxEnumRoutingMethodsW(
    IntPtr FaxPortHandle,   // HANDLE
    IntPtr RoutingMethod,   // FAX_ROUTING_METHODW** out
    out uint MethodsReturned   // DWORD* out
);
<DllImport("WINFAX.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FaxEnumRoutingMethodsW(
    FaxPortHandle As IntPtr,   ' HANDLE
    RoutingMethod As IntPtr,   ' FAX_ROUTING_METHODW** out
    <Out> ByRef MethodsReturned As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' FaxPortHandle : HANDLE
' RoutingMethod : FAX_ROUTING_METHODW** out
' MethodsReturned : DWORD* out
Declare PtrSafe Function FaxEnumRoutingMethodsW Lib "winfax" ( _
    ByVal FaxPortHandle As LongPtr, _
    ByVal RoutingMethod As LongPtr, _
    ByRef MethodsReturned 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

FaxEnumRoutingMethodsW = ctypes.windll.winfax.FaxEnumRoutingMethodsW
FaxEnumRoutingMethodsW.restype = wintypes.BOOL
FaxEnumRoutingMethodsW.argtypes = [
    wintypes.HANDLE,  # FaxPortHandle : HANDLE
    ctypes.c_void_p,  # RoutingMethod : FAX_ROUTING_METHODW** out
    ctypes.POINTER(wintypes.DWORD),  # MethodsReturned : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	winfax = windows.NewLazySystemDLL("WINFAX.dll")
	procFaxEnumRoutingMethodsW = winfax.NewProc("FaxEnumRoutingMethodsW")
)

// FaxPortHandle (HANDLE), RoutingMethod (FAX_ROUTING_METHODW** out), MethodsReturned (DWORD* out)
r1, _, err := procFaxEnumRoutingMethodsW.Call(
	uintptr(FaxPortHandle),
	uintptr(RoutingMethod),
	uintptr(MethodsReturned),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function FaxEnumRoutingMethodsW(
  FaxPortHandle: THandle;   // HANDLE
  RoutingMethod: Pointer;   // FAX_ROUTING_METHODW** out
  MethodsReturned: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'WINFAX.dll' name 'FaxEnumRoutingMethodsW';
result := DllCall("WINFAX\FaxEnumRoutingMethodsW"
    , "Ptr", FaxPortHandle   ; HANDLE
    , "Ptr", RoutingMethod   ; FAX_ROUTING_METHODW** out
    , "Ptr", MethodsReturned   ; DWORD* out
    , "Int")   ; return: BOOL
●FaxEnumRoutingMethodsW(FaxPortHandle, RoutingMethod, MethodsReturned) = DLL("WINFAX.dll", "bool FaxEnumRoutingMethodsW(void*, void*, void*)")
# 呼び出し: FaxEnumRoutingMethodsW(FaxPortHandle, RoutingMethod, MethodsReturned)
# FaxPortHandle : HANDLE -> "void*"
# RoutingMethod : FAX_ROUTING_METHODW** out -> "void*"
# MethodsReturned : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "winfax" fn FaxEnumRoutingMethodsW(
    FaxPortHandle: ?*anyopaque, // HANDLE
    RoutingMethod: [*c][*c]FAX_ROUTING_METHODW, // FAX_ROUTING_METHODW** out
    MethodsReturned: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc FaxEnumRoutingMethodsW(
    FaxPortHandle: pointer,  # HANDLE
    RoutingMethod: ptr FAX_ROUTING_METHODW,  # FAX_ROUTING_METHODW** out
    MethodsReturned: ptr uint32  # DWORD* out
): int32 {.importc: "FaxEnumRoutingMethodsW", stdcall, dynlib: "WINFAX.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "winfax");
extern(Windows)
int FaxEnumRoutingMethodsW(
    void* FaxPortHandle,   // HANDLE
    FAX_ROUTING_METHODW** RoutingMethod,   // FAX_ROUTING_METHODW** out
    uint* MethodsReturned   // DWORD* out
);
ccall((:FaxEnumRoutingMethodsW, "WINFAX.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{FAX_ROUTING_METHODW}, Ptr{UInt32}),
      FaxPortHandle, RoutingMethod, MethodsReturned)
# FaxPortHandle : HANDLE -> Ptr{Cvoid}
# RoutingMethod : FAX_ROUTING_METHODW** out -> Ptr{FAX_ROUTING_METHODW}
# MethodsReturned : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t FaxEnumRoutingMethodsW(
    void* FaxPortHandle,
    void* RoutingMethod,
    uint32_t* MethodsReturned);
]]
local winfax = ffi.load("winfax")
-- winfax.FaxEnumRoutingMethodsW(FaxPortHandle, RoutingMethod, MethodsReturned)
-- FaxPortHandle : HANDLE
-- RoutingMethod : FAX_ROUTING_METHODW** out
-- MethodsReturned : 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 FaxEnumRoutingMethodsW = lib.func('__stdcall', 'FaxEnumRoutingMethodsW', 'int32_t', ['void *', 'void *', 'uint32_t *']);
// FaxEnumRoutingMethodsW(FaxPortHandle, RoutingMethod, MethodsReturned)
// FaxPortHandle : HANDLE -> 'void *'
// RoutingMethod : FAX_ROUTING_METHODW** out -> 'void *'
// MethodsReturned : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINFAX.dll", {
  FaxEnumRoutingMethodsW: { parameters: ["pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.FaxEnumRoutingMethodsW(FaxPortHandle, RoutingMethod, MethodsReturned)
// FaxPortHandle : HANDLE -> "pointer"
// RoutingMethod : FAX_ROUTING_METHODW** out -> "pointer"
// MethodsReturned : DWORD* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t FaxEnumRoutingMethodsW(
    void* FaxPortHandle,
    void* RoutingMethod,
    uint32_t* MethodsReturned);
C, "WINFAX.dll");
// $ffi->FaxEnumRoutingMethodsW(FaxPortHandle, RoutingMethod, MethodsReturned);
// FaxPortHandle : HANDLE
// RoutingMethod : FAX_ROUTING_METHODW** out
// MethodsReturned : 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 FaxEnumRoutingMethodsW(
        Pointer FaxPortHandle,   // HANDLE
        Pointer RoutingMethod,   // FAX_ROUTING_METHODW** out
        IntByReference MethodsReturned   // DWORD* out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("winfax")]
lib LibWINFAX
  fun FaxEnumRoutingMethodsW = FaxEnumRoutingMethodsW(
    FaxPortHandle : Void*,   # HANDLE
    RoutingMethod : FAX_ROUTING_METHODW**,   # FAX_ROUTING_METHODW** out
    MethodsReturned : 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 FaxEnumRoutingMethodsWNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
typedef FaxEnumRoutingMethodsWDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
final FaxEnumRoutingMethodsW = DynamicLibrary.open('WINFAX.dll')
    .lookupFunction<FaxEnumRoutingMethodsWNative, FaxEnumRoutingMethodsWDart>('FaxEnumRoutingMethodsW');
// FaxPortHandle : HANDLE -> Pointer<Void>
// RoutingMethod : FAX_ROUTING_METHODW** out -> Pointer<Void>
// MethodsReturned : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FaxEnumRoutingMethodsW(
  FaxPortHandle: THandle;   // HANDLE
  RoutingMethod: Pointer;   // FAX_ROUTING_METHODW** out
  MethodsReturned: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'WINFAX.dll' name 'FaxEnumRoutingMethodsW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FaxEnumRoutingMethodsW"
  c_FaxEnumRoutingMethodsW :: Ptr () -> Ptr () -> Ptr Word32 -> IO CInt
-- FaxPortHandle : HANDLE -> Ptr ()
-- RoutingMethod : FAX_ROUTING_METHODW** out -> Ptr ()
-- MethodsReturned : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let faxenumroutingmethodsw =
  foreign "FaxEnumRoutingMethodsW"
    ((ptr void) @-> (ptr void) @-> (ptr uint32_t) @-> returning int32_t)
(* FaxPortHandle : HANDLE -> (ptr void) *)
(* RoutingMethod : FAX_ROUTING_METHODW** out -> (ptr void) *)
(* MethodsReturned : 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 ("FaxEnumRoutingMethodsW" fax-enum-routing-methods-w :convention :stdcall) :int32
  (fax-port-handle :pointer)   ; HANDLE
  (routing-method :pointer)   ; FAX_ROUTING_METHODW** out
  (methods-returned :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FaxEnumRoutingMethodsW = Win32::API::More->new('WINFAX',
    'BOOL FaxEnumRoutingMethodsW(HANDLE FaxPortHandle, LPVOID RoutingMethod, LPVOID MethodsReturned)');
# my $ret = $FaxEnumRoutingMethodsW->Call($FaxPortHandle, $RoutingMethod, $MethodsReturned);
# FaxPortHandle : HANDLE -> HANDLE
# RoutingMethod : FAX_ROUTING_METHODW** out -> LPVOID
# MethodsReturned : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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