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

FaxEnumGlobalRoutingInfoA

関数
ファクスのグローバルルーティング情報を列挙する。
DLLWINFAX.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

BOOL FaxEnumGlobalRoutingInfoA(
    HANDLE FaxHandle,
    FAX_GLOBAL_ROUTING_INFOA** RoutingInfo,
    DWORD* MethodsReturned
);

パラメーター

名前型方向説明
FaxHandleHANDLEinFaxConnectFaxServer 関数の呼び出しによって返されたファックスサーバーのハンドルを指定します。
RoutingInfoFAX_GLOBAL_ROUTING_INFOA**outFAX_GLOBAL_ROUTING_INFO 構造体の配列を受け取るバッファーのアドレスへのポインター。各構造体には、ファックスサービス全体に適用される 1 つのファックスルーティング方法に関する情報が格納されます。このデータには、特に、ファックスルーティング方法の優先度と、そのルーティング方法をエクスポートする DLL の名前が含まれます。また、ルーティング方法を識別する GUID と関数名、およびその方法のわかりやすい名前も含まれます。メモリの割り当てについては、後述の「解説」セクションを参照してください。
MethodsReturnedDWORD*out関数が RoutingInfo パラメーターで返す FAX_GLOBAL_ROUTING_INFO 構造体の数を受け取る DWORD 変数へのポインター。この数は、対象のサーバーにインストールされているファックスルーティング方法の総数と等しくなります。

戻り値の型: BOOL

公式ドキュメント

FaxEnumGlobalRoutingInfo 関数は、特定のファックスサーバーに関連付けられているすべてのファックスルーティング方法を列挙します。(ANSI)

戻り値

種類: BOOL

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。GetLastError は次のいずれかのエラーを返すことがあります。

戻り値 説明
ERROR_ACCESS_DENIED
 アクセスが拒否されました。FAX_CONFIG_QUERY アクセス権が必要です。
ERROR_INVALID_PARAMETER
 MethodsReturned、RoutingInfo、FaxHandle の各パラメーターのいずれか、またはすべてが NULL です。
ERROR_NOT_ENOUGH_MEMORY
 メモリの割り当て中にエラーが発生しました。

解説(Remarks)

FaxEnumGlobalRoutingInfo 関数は、ルーティングの優先度など、ファックスサーバー全体に適用されるファックスルーティング方法の情報を取得します。アプリケーションは、FaxSetGlobalRoutingInfo 関数を呼び出すことで、グローバルなデータを変更できます。

アプリケーションは、FaxEnumRoutingMethods 関数を呼び出すことで、特定のデバイスに関連付けられているファックスルーティング方法を列挙できます。

FaxEnumGlobalRoutingInfo 関数は、RoutingInfo パラメーターが指す FAX_GLOBAL_ROUTING_INFO のバッファー配列に必要なメモリを割り当てます。アプリケーションは、FaxFreeBuffer 関数を呼び出して、このパラメーターに関連付けられているリソースを解放する必要があります。詳細については、Freeing Fax Resources および Managing Fax Routing Data を参照してください。

メモ

winfax.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして FaxEnumGlobalRoutingInfo を定義します。エンコードに依存しないエイリアスを、エンコードに依存するコードと混在させて使用すると、不一致が生じ、コンパイルエラーまたは実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

BOOL FaxEnumGlobalRoutingInfoA(
    HANDLE FaxHandle,
    FAX_GLOBAL_ROUTING_INFOA** RoutingInfo,
    DWORD* MethodsReturned
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINFAX.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool FaxEnumGlobalRoutingInfoA(
    IntPtr FaxHandle,   // HANDLE
    IntPtr RoutingInfo,   // FAX_GLOBAL_ROUTING_INFOA** out
    out uint MethodsReturned   // DWORD* out
);
<DllImport("WINFAX.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FaxEnumGlobalRoutingInfoA(
    FaxHandle As IntPtr,   ' HANDLE
    RoutingInfo As IntPtr,   ' FAX_GLOBAL_ROUTING_INFOA** out
    <Out> ByRef MethodsReturned As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' FaxHandle : HANDLE
' RoutingInfo : FAX_GLOBAL_ROUTING_INFOA** out
' MethodsReturned : DWORD* out
Declare PtrSafe Function FaxEnumGlobalRoutingInfoA Lib "winfax" ( _
    ByVal FaxHandle As LongPtr, _
    ByVal RoutingInfo As LongPtr, _
    ByRef MethodsReturned As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FaxEnumGlobalRoutingInfoA = ctypes.windll.winfax.FaxEnumGlobalRoutingInfoA
FaxEnumGlobalRoutingInfoA.restype = wintypes.BOOL
FaxEnumGlobalRoutingInfoA.argtypes = [
    wintypes.HANDLE,  # FaxHandle : HANDLE
    ctypes.c_void_p,  # RoutingInfo : FAX_GLOBAL_ROUTING_INFOA** 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')
FaxEnumGlobalRoutingInfoA = Fiddle::Function.new(
  lib['FaxEnumGlobalRoutingInfoA'],
  [
    Fiddle::TYPE_VOIDP,  # FaxHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # RoutingInfo : FAX_GLOBAL_ROUTING_INFOA** out
    Fiddle::TYPE_VOIDP,  # MethodsReturned : DWORD* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "winfax")]
extern "system" {
    fn FaxEnumGlobalRoutingInfoA(
        FaxHandle: *mut core::ffi::c_void,  // HANDLE
        RoutingInfo: *mut *mut FAX_GLOBAL_ROUTING_INFOA,  // FAX_GLOBAL_ROUTING_INFOA** 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.Ansi, SetLastError = true)]
public static extern bool FaxEnumGlobalRoutingInfoA(IntPtr FaxHandle, IntPtr RoutingInfo, out uint MethodsReturned);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINFAX_FaxEnumGlobalRoutingInfoA' -Namespace Win32 -PassThru
# $api::FaxEnumGlobalRoutingInfoA(FaxHandle, RoutingInfo, MethodsReturned)
#uselib "WINFAX.dll"
#func global FaxEnumGlobalRoutingInfoA "FaxEnumGlobalRoutingInfoA" sptr, sptr, sptr
; FaxEnumGlobalRoutingInfoA FaxHandle, varptr(RoutingInfo), varptr(MethodsReturned)   ; 戻り値は stat
; FaxHandle : HANDLE -> "sptr"
; RoutingInfo : FAX_GLOBAL_ROUTING_INFOA** out -> "sptr"
; MethodsReturned : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "WINFAX.dll"
#cfunc global FaxEnumGlobalRoutingInfoA "FaxEnumGlobalRoutingInfoA" sptr, var, var
; res = FaxEnumGlobalRoutingInfoA(FaxHandle, RoutingInfo, MethodsReturned)
; FaxHandle : HANDLE -> "sptr"
; RoutingInfo : FAX_GLOBAL_ROUTING_INFOA** out -> "var"
; MethodsReturned : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; BOOL FaxEnumGlobalRoutingInfoA(HANDLE FaxHandle, FAX_GLOBAL_ROUTING_INFOA** RoutingInfo, DWORD* MethodsReturned)
#uselib "WINFAX.dll"
#cfunc global FaxEnumGlobalRoutingInfoA "FaxEnumGlobalRoutingInfoA" intptr, var, var
; res = FaxEnumGlobalRoutingInfoA(FaxHandle, RoutingInfo, MethodsReturned)
; FaxHandle : HANDLE -> "intptr"
; RoutingInfo : FAX_GLOBAL_ROUTING_INFOA** out -> "var"
; MethodsReturned : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winfax = windows.NewLazySystemDLL("WINFAX.dll")
	procFaxEnumGlobalRoutingInfoA = winfax.NewProc("FaxEnumGlobalRoutingInfoA")
)

// FaxHandle (HANDLE), RoutingInfo (FAX_GLOBAL_ROUTING_INFOA** out), MethodsReturned (DWORD* out)
r1, _, err := procFaxEnumGlobalRoutingInfoA.Call(
	uintptr(FaxHandle),
	uintptr(RoutingInfo),
	uintptr(MethodsReturned),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function FaxEnumGlobalRoutingInfoA(
  FaxHandle: THandle;   // HANDLE
  RoutingInfo: Pointer;   // FAX_GLOBAL_ROUTING_INFOA** out
  MethodsReturned: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'WINFAX.dll' name 'FaxEnumGlobalRoutingInfoA';
result := DllCall("WINFAX\FaxEnumGlobalRoutingInfoA"
    , "Ptr", FaxHandle   ; HANDLE
    , "Ptr", RoutingInfo   ; FAX_GLOBAL_ROUTING_INFOA** out
    , "Ptr", MethodsReturned   ; DWORD* out
    , "Int")   ; return: BOOL
●FaxEnumGlobalRoutingInfoA(FaxHandle, RoutingInfo, MethodsReturned) = DLL("WINFAX.dll", "bool FaxEnumGlobalRoutingInfoA(void*, void*, void*)")
# 呼び出し: FaxEnumGlobalRoutingInfoA(FaxHandle, RoutingInfo, MethodsReturned)
# FaxHandle : HANDLE -> "void*"
# RoutingInfo : FAX_GLOBAL_ROUTING_INFOA** out -> "void*"
# MethodsReturned : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

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

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

関連項目

文字セット違い
公式の関連項目
使用する型